Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Users

Update an existing user

Updates details for a given user.

You need the "Create and update users" permission to use this endpoint.

patch/v2/users/{user_identifier}

Path parameters

user_identifierstring uuid required

The identifier of the user that you want to update.

Request body

activeboolean

If the user is active or deactivated.

enforce_mfa_afterstring date-time

Date and time of when MFA will be enforced for the user.

namestring

Full name of the user.

Example request

{
  "active": true,
  "enforce_mfa_after": "2024-06-01T00:00:00.000Z",
  "name": "John Doe"
}

Response

OK

activeboolean required

If a user is active or deactivated.

client_identifierstring uuid required

The unique identifier of the client.

created_atstring date-time required

Date and time the user was created.

created_bystring uuid required

The unique identifier of who created the user.

deactivated_atstring date-time

Date and time the user was deactivated.

emailstring required

Email address of the user.

enforce_mfa_afterstring date-time

Date and time of when MFA will be enforced for the user.

identifierstring uuid required

The unique identifier of the user.

namestring required

Full name of the user.

updated_atstring date-time required

Date and time the user was last updated.

updated_bystring uuid required

The unique identifier of who last updated the user.

user_type'AGENT' | 'HUMAN' | 'MACHINE_CREDENTIAL' required

Specifies the type of the entity.

Example response

{
  "active": true,
  "client_identifier": "00000000-0000-0000-0000-000000000000",
  "email": "example@mail.com",
  "identifier": "00000000-0000-0000-0000-000000000000",
  "name": "John Doe",
  "user_type": "HUMAN"
}