Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
access_schedule
object | null

starts_at and ends_at timestamps for the access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

​
acs_system_id
string<uuid>

ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.

​
acs_user_id
string<uuid>

ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.

​
email
string<email>
deprecated

Deprecated. use email_address.

​
email_address
string<email>

Email address of the access system user.

​
full_name
string

Full name of the access system user.

Minimum string length: 1
​
hid_acs_system_id
string<uuid>

ID of the HID access control system associated with the user.

​
phone_number
string

Phone number of the access system user in E.164 format (for example, +15555550100).

​
user_identity_id
string<uuid>

ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.

Response

OK

The response is of type object.