ACS Users
Last updated
Was this helpful?
Last updated
Was this helpful?
acs_userRepresents a in an .
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 .
access_scheduleFormat: Object
starts_at and ends_at timestamps for the access.
---
acs_system_idFormat: UUID
acs_user_idFormat: UUID
created_atFormat: Datetime
display_nameFormat: String
emailDeprecated. use email_address.
Format: String
email_addressFormat: String
Format: List
Item format: Object
external_typeFormat: Enum
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_nameFormat: String
full_nameFormat: String
hid_acs_system_idFormat: UUID
is_managedFormat: Boolean
is_suspendedFormat: Boolean
phone_numberFormat: String
user_identity_email_addressFormat: String
user_identity_full_nameFormat: String
user_identity_idFormat: String
user_identity_phone_numberFormat: String
Format: List
Item format: Object
workspace_idFormat: UUID
deleted_externallysalto_ks_subscription_limit_exceededfailed_to_create_on_acs_systemfailed_to_update_on_acs_systemfailed_to_delete_on_acs_systembeing_deletedsalto_ks_user_not_subscribedunknown_issue_with_acs_useracs_user.created---
acs_user.deleted---
ID of the that contains the .
ID of the .
Date and time at which the was created.
Display name for the .
Email address of the .
Errors associated with the .
Brand-specific terminology for the type.
Display name that corresponds to the brand-specific terminology for the type.
Full name of the .
Indicates whether the is currently .
Phone number of the in E.164 format (for example, +15555550100).
Email address of the user identity associated with the .
Full name of the user identity associated with the .
ID of the user identity associated with the .
Phone number of the user identity associated with the in E.164 format (for example, +15555550100).
Warnings associated with the .
ID of the that contains the .
Indicates that the was deleted from the outside of Seam.
Indicates that the could not be subscribed on Salto KS because the subscription limit has been exceeded.
Indicates that the was not created on the . This is likely due to an internal unexpected error. Contact Seam .
Indicates that the was not updated on the . This is likely due to an internal unexpected error. Contact Seam .
Indicates that the was not deleted on the . This is likely due to an internal unexpected error. Contact Seam .
Indicates that the is being deleted from the . This is a temporary state, and the ACS user will be deleted shortly.
Indicates that the 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.
An unknown issue occurred while syncing the state of this with the provider. This issue may affect the proper functioning of this user.
Adds a specified to a specified .
Creates a new .
Deletes a specified and invalidates the ACS user's .
Returns a specified .
Returns a list of all .
Lists the to which a specified has access.
Removes a specified from a specified .
Revokes access to all for a specified .
a specified . Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can them.
a specified suspended . While revokes their access temporarily, unsuspending the ACS user restores their access.
Updates the properties of a specified .
An was created.
ID of the .
ID of the .
ID of the .
An was deleted.
ID of the .
ID of the .
ID of the .