Sign in
User

Update a user

Updates a user in your organization.

:::info Only users of type person can be updated. :::

put/user/{id}

Path parameters

idinteger required

The ID of the user you want to update.

ℹ️ Note: Only users of type person can be updated.

Request body

status'active' | 'inactive'

The status of the user you want to update.

ℹ️ Info: Set the status to active to allow the user to log in to the platform, or to inactive to prevent login access.

emailstring

The email of the user you want to update.

first_namestring

The first name of the user you want to update.

last_namestring

The last name of the user you want to update.

organization_idinteger

The organization ID of the user you want to update.

avatarstring

The avatar of the user you want to update.

Example request

{
  "status": "active",
  "email": "alex.doe@email.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "organization_id": 1234,
  "avatar": "https://my-avatar-url.com"
}

Response

The operation was successful.

idinteger required

The ID of the user.

emailstring required

The email of the user.

first_namestring nullable required

The first name of the user.

last_namestring nullable required

The last name of the user.

organization_idinteger required

The organization ID of the user.

status'active' | 'inactive' | 'pending' | 'invited'

The status of the user.

avatarstring nullable

The avatar of the user.

type'person' | 'machine'

The type of the user.

provider'cognito' | 'saml' nullable

The authentication provider of the user.

nrnstring required

The NRN of the user.

send_inviteboolean

Whether to send an invite email to the user.

metadataobject

The metadata of the user.

Example response

{
  "id": 123456,
  "email": "alex.mgr@crypto-inc.com",
  "first_name": "Alex",
  "last_name": "Doe",
  "organization_id": 1234,
  "status": "active",
  "avatar": "https://my-avatar-url.com",
  "type": "person",
  "provider": "cognito",
  "nrn": "organization=123",
  "send_invite": true,
  "metadata": {
    "key": "value"
  }
}

Changes