Users

ACS users to whom to grant access to specific physical spaces

The acs_user object represents a user within an access control system (ACS).

acs_user Properties

The acs_user object has the following properties:

Property	Type	Description
acs_user_id	String (UUID) Required	ID of the user
acs_system_id	String (UUID) Required	ID of the access control system that contains the user
workspace_id	String (UUID) Required	ID of the workspace that contains the user
created_at	String Required	Date and time at which the user was created
display_name	String Required	Display name for the user
external_type	String Optional	Brand-specific terminology for the user type
external_type_display_name	String Optional	Display name that corresponds to the brand-specific terminology for the user type
is_suspended	Boolean Required	Indicates whether the user is currently suspended
access_schedule	Object Optional	starts_at and ends_at dates/times for the user's access
user_identity_id	String (UUID) Optional	ID of the user identity associated with the user
user_identity_email_address	String Optional	Email address of the user identity associated with the user
user_identity_phone_number	String Optional	Phone number of the user identity associated with the user in E.164 format (for example, [phone])
full_name	String Optional	Full name of the user
email_address	String Optional	Email address of the user
phone_number	String Optional	Phone number of the user in E.164 format (for example, [phone])

acs_user Methods

You can perform the following actions on acs_user objects:

• Create a user

• List users

• Get a user

• Update a user

• Suspend a user

• Unsuspend a user

• Delete a user

• Add a user to an access group

• Remove a user from an access group