Update user role in workspace

Updates the role of a user in the workspace.

PUT /users/{subOrEmail}

Update user role in workspace

cURL

curl --request PUT \
  --url https://api.blaxel.ai/v0/users/{subOrEmail} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "<string>"
}
'

200

{
  "accepted": true,
  "email": "<string>",
  "email_verified": true,
  "expired": true,
  "family_name": "<string>",
  "given_name": "<string>",
  "role": "<string>",
  "sub": "<string>"
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Path Parameters

subOrEmail · string · required

Sub or email of the user

Body

application/json

role · string · required

The new role to assign to the user

Response

200

application/json

User role updated successfully

Workspace user

accepted · boolean

Whether the user has accepted the workspace invitation

email · string

Workspace user email

email_verified · boolean

Whether the user's email has been verified

expired · boolean

Whether the invitation has expired

family_name · string

Workspace user family name

given_name · string

Workspace user given name

role · string

Workspace user role

source · enum<string>

Source of the user provisioning

Available options: directory_sync, invitation, domain_capture

sub · string

Workspace user identifier