Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Users

Update your user

Update details for your user.

patch/v2/users/me

Request body

cookie_consentboolean

Whether the user consents to cookies.

locale'en-US' | 'en-GB' | 'fr-CA' | 'fr-FR'

User locale.

Example request

{
  "locale": "en-US"
}

Response

OK

activeboolean required

If a user is active or deactivated.

client_identifierstring uuid required

The unique identifier of the client.

cookie_consentboolean required

Whether the user has consented to cookies.

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.

is_default_localeboolean required

Default locale is used.

locale'en-US' | 'en-GB' | 'fr-CA' | 'fr-FR' required

Locale of the user.

namestring required

Full name of the user.

prompt_user_cookieboolean required

Whether to prompt the user about cookie consent.

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.

Example response

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