ACS Users

acs_user

Represents a user in an access control system.

access_schedule

Format: Object

starts_at and ends_at timestamps for the acs_user's access.

ends_at datetime

Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

starts_at datetime

Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.


acs_system_id

Format: ID

ID of the access control system that contains the acs_user.


acs_user_id

Format: ID

ID of the acs_user.


created_at

Format: Datetime

Date and time at which the acs_user was created.


display_name

Format: String

Display name for the acs_user.


email

Deprecated. use email_address.

Format: String


email_address

Format: String

Email address of the acs_user.


errors

Format: List

Errors associated with the acs_user.


external_type

Format: Enum

Brand-specific terminology for the acs_user type.

Possible enum values:

  • pti_user

  • brivo_user

  • hid_credential_manager_user

  • salto_site_user

  • latch_user

  • dormakaba_community_user


external_type_display_name

Format: String

Display name that corresponds to the brand-specific terminology for the acs_user type.


full_name

Format: String

Full name of the acs_user.


hid_acs_system_id

Format: ID


is_managed

Format: Boolean


is_suspended

Format: Boolean

Indicates whether the acs_user is currently suspended.


phone_number

Format: String

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


user_identity_email_address

Format: String

Email address of the user identity associated with the acs_user.


user_identity_full_name

Format: String

Full name of the user identity associated with the acs_user.


user_identity_id

Format: String

ID of the user identity associated with the acs_user.


user_identity_phone_number

Format: String

Phone number of the user identity associated with the acs_user in E.164 format (for example, +15555550100).


warnings

Format: List

Warnings associated with the acs_user.


workspace_id

Format: ID

ID of the workspace that contains the acs_user.


Endpoints

Adds a specified ACS user to a specified access group.

Creates a new ACS user.

Deletes a specified ACS user and invalidates the ACS user's credentials.

Returns a specified ACS user.

Returns a list of all ACS users.

Lists the entrances to which a specified ACS user has access.

Removes a specified ACS user from a specified access group.

Revokes access to all entrances for a specified ACS user.

Suspends a specified ACS user. Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can unsuspend them.

Unsuspends a specified suspended ACS user. While suspending an ACS user revokes their access temporarily, unsuspending the ACS user restores their access.

Updates the properties of a specified ACS user.

Last updated

Logo

© Seam Labs, Inc. All rights reserved.