BEbeyondidentity
Users

Update a user

To update only specific attributes of an existing user, send a PATCH request to /v2/users/$USER_ID. Values in the request body for immutable or read-only fields get ignored. Fields omitted from the request body will be left unchanged. If the request conflicts with an existing resource, you'll receive a 409 error.

patch/v2/users/{user_id}

Request

Path parameters

user_idstring required
Example:25f94daf-63d8-4b40-b0ea-4843971d1d8e

A unique identifier for a user.

Request body

Example request

{
  "user": {
    "id": "e7bb3e0b-91fd-432a-bc96-55801329adbf",
    "create_time": "2022-04-12T05:53:07.119Z",
    "update_time": "2022-06-16T14:31:03.770Z",
    "last_auth_time": "2022-06-16T14:31:03.770Z",
    "tenant_id": "acme-corp",
    "external_id": "0001f1f460b1ace6",
    "email_address": "alice@acmecorp.com",
    "username": "alice.acmecorp",
    "display_name": "Alice Acmecorp",
    "state": "ACTIVE",
    "source": "scim",
    "has_active_passkey": true
  }
}

Response

The response is a JSON object containing standard user attributes.

idstring

A unique identifier for the user within a tenant that is automatically generated on creation. This field is immutable and read-only.

create_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the user gets created. This field is immutable and read-only.

update_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the user gets updated. This field is immutable and read-only.

last_auth_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the user last authenticated. This field is immutable and read-only.

tenant_idstring

A unique identifier for the user's tenant that is set automatically on creation. This field is immutable and read-only.

external_idstring

A required unique identifier for the user within the tenant.

email_addressstring

A required email address serving as primary contact for user.

usernamestring

A required username for the user.

display_namestring

A required human-readable name for the user that is used for display purposes.

state'ACTIVE' | 'SUSPENDED' | 'DELETED'

State of the user that gets updated automatically when the user is updated. This field is read-only.

sourcestring

The source that created the user. This field is immutable and read-only.

has_active_passkeyboolean

A flag representing if the user has at least one device credential in an ACTIVE state. It's updated automatically when the user creates or revokes any passkeys. This field is read-only.

Example response

{
  "id": "e7bb3e0b-91fd-432a-bc96-55801329adbf",
  "create_time": "2022-04-12T05:53:07.119Z",
  "update_time": "2022-06-16T14:31:03.770Z",
  "last_auth_time": "2022-06-16T14:31:03.770Z",
  "tenant_id": "acme-corp",
  "external_id": "0001f1f460b1ace6",
  "email_address": "alice@acmecorp.com",
  "username": "alice.acmecorp",
  "display_name": "Alice Acmecorp",
  "state": "ACTIVE",
  "source": "scim",
  "has_active_passkey": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.