Bulk Patch Users

Bulk user management API, reserved to super admins.

PATCH /v2/users

Bulk Patch Users

cURL

curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "ids": [
      "<string>"
    ],
    "emails": [
      "<string>"
    ]
  },
  "data": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "[e-mail]",
    "meta": {},
    "platformRole": "<string>",
    "groups": [
      "<string>"
    ],
    "groupAcls": {}
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: {ids: ['<string>'], emails: ['<string>']},
    data: {
      firstName: '<string>',
      lastName: '<string>',
      email: '[e-mail]',
      meta: {},
      platformRole: '<string>',
      groups: ['<string>'],
      groupAcls: {}
    }
  })
};

fetch('https://api.studio.prisme.ai/v2/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/users"

payload = {
    "query": {
        "ids": ["<string>"],
        "emails": ["<string>"]
    },
    "data": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "[e-mail]",
        "meta": {},
        "platformRole": "<string>",
        "groups": ["<string>"],
        "groupAcls": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "requestedCount": 123,
  "matchedCount": 123,
  "modifiedCount": 123
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query · object · required

Option 1

Option 2

Hide child attributes

query. ids · string[] · required

query. emails · string[]

data · object · required

Hide child attributes

data. firstName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

data. lastName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

data. email · string<email>

data. status · enum<string>

Available options: pending, validated, deactivated

data. meta · object

data. platformRole · string

data. groups · string[]

data. groupAcls · object

Hide child attributes

data.groupAcls. {key} · object

Hide child attributes

data.groupAcls.{key}. role · string

behaviour · object

Hide child attributes

behaviour. groups · enum<string>

Available options: replace, add, delete

Response

200

application/json

Bulk update result

requestedCount · number

Number of users requested to be updated

matchedCount · number

Number of users found and matched

modifiedCount · number

Number of users actually modified