Users

Update user

Update a user

patch/zones/{zoneId}/users/{id}

Path parameters

zoneIdstring required

Zone ID

idstring required

User ID

Request body

identifierstring

Zone-scoped user identifier

Response

An authenticated user entity

idstring required

Unique identifier of the user

organization_idstring required

Organization that owns this user

zone_idstring required

Zone this user belongs to

identifierstring required

Zone-scoped user identifier. Defaults to the user's Keycard ID. When the provider has user_identifier_claim configured, the value is set from that claim at user creation time.

subjectstring

Subject identifier from the identity provider

issuerstring

Issuer identifier of the identity provider

emailstring email required

Email address of the user

email_verifiedboolean required

Whether the email address has been verified

provider_idstring

Reference to the identity provider. This field is undefined when the source identity provider is deleted but the user is not deleted.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

authenticated_atstring

Date when the user was last authenticated

Changes