ACS Users

`acs_user`

Represents a user in an access control system.

An acs_user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.

For details about how to configure acs_users in your access control system, see the corresponding system integration guide.

`access_schedule`

Format: Object

starts_at and ends_at timestamps for the ACS user's access.

ends_at Format: Datetime

Date and time at which the user's access ends, in ISO 8601 format.

starts_at Format: Datetime

Date and time at which the user's access starts, in ISO 8601 format.

`acs_system_id`

Format: UUID

ID of the access control system that contains the ACS user.

`acs_user_id`

Format: UUID

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

Item format: Object

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
salto_space_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: UUID

`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

Item format: Object

Warnings associated with the ACS user.

`workspace_id`

Format: UUID

ID of the workspace that contains the ACS user.

Errors

`deleted_externally`

Indicates that the ACS user was deleted from the access control system outside of Seam.

`salto_ks_subscription_limit_exceeded`

Indicates that the ACS user could not be subscribed on Salto KS because the subscription limit has been exceeded.

`failed_to_create_on_acs_system`

Indicates that the ACS user was not created on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

`failed_to_update_on_acs_system`

Indicates that the ACS user was not updated on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

`failed_to_delete_on_acs_system`

Indicates that the ACS user was not deleted on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

Warnings

`being_deleted`

Indicates that the ACS user is being deleted from the access control system. This is a temporary state, and the ACS user will be deleted shortly.

`salto_ks_user_not_subscribed`

Indicates that the ACS user is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.

`unknown_issue_with_acs_user`

An unknown issue occurred while syncing the state of this ACS user with the provider. This issue may affect the proper functioning of this user.

Endpoints

`/acs/users/add_to_access_group`

Adds a specified ACS user to a specified access group.

`/acs/users/create`

Creates a new ACS user.

`/acs/users/delete`

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

`/acs/users/get`

Returns a specified ACS user.

`/acs/users/list`

Returns a list of all ACS users.

`/acs/users/list_accessible_entrances`

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

`/acs/users/remove_from_access_group`

Removes a specified ACS user from a specified access group.

`/acs/users/revoke_access_to_all_entrances`

Revokes access to all entrances for a specified ACS user.

`/acs/users/suspend`

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

`/acs/users/unsuspend`

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

`/acs/users/update`

Updates the properties of a specified ACS user.

Events

`acs_user.deleted`

An ACS user was deleted.

acs_system_id Format: UUID

ID of the ACS system.

acs_user_id Format: UUID

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

PreviousList Compatible Credential Manager ACS Systems NextCreate an ACS User

Last updated 1 day ago

Was this helpful?

ACS Users

`acs_user`

Represents a user in an access control system.

For details about how to configure acs_users in your access control system, see the corresponding system integration guide.

`access_schedule`

Format: Object

starts_at and ends_at timestamps for the ACS user's access.

ends_at Format: Datetime

Date and time at which the user's access ends, in ISO 8601 format.

starts_at Format: Datetime

Date and time at which the user's access starts, in ISO 8601 format.

`acs_system_id`

Format: UUID

ID of the access control system that contains the ACS user.

`acs_user_id`

Format: UUID

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

Item format: Object

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
salto_space_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: UUID

`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

Item format: Object

Warnings associated with the ACS user.

`workspace_id`

Format: UUID

ID of the workspace that contains the ACS user.

Errors

`deleted_externally`

Indicates that the ACS user was deleted from the access control system outside of Seam.

`salto_ks_subscription_limit_exceeded`

Indicates that the ACS user could not be subscribed on Salto KS because the subscription limit has been exceeded.

`failed_to_create_on_acs_system`

Indicates that the ACS user was not created on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

`failed_to_update_on_acs_system`

Indicates that the ACS user was not updated on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

`failed_to_delete_on_acs_system`

Indicates that the ACS user was not deleted on the access control system. This is likely due to an internal unexpected error. Contact Seam support.

Warnings

`being_deleted`

Indicates that the ACS user is being deleted from the access control system. This is a temporary state, and the ACS user will be deleted shortly.

`salto_ks_user_not_subscribed`

`unknown_issue_with_acs_user`

An unknown issue occurred while syncing the state of this ACS user with the provider. This issue may affect the proper functioning of this user.

Events

`acs_user.deleted`

An ACS user was deleted.

acs_system_id Format: UUID

ID of the ACS system.

acs_user_id Format: UUID

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

PreviousList Compatible Credential Manager ACS Systems NextCreate an ACS User

Last updated 1 day ago

Was this helpful?