ACS Users

The acs_user Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

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.

---

Properties

access_schedule Object

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

Child Properties

• ends_at Datetime

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

• starts_at Datetime

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

---

acs_system_id UUID

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

---

acs_user_id UUID

ID of the ACS user.

---

connected_account_id UUID

The ID of the connected account that is associated with the ACS user.

---

created_at Datetime

Date and time at which the ACS user was created.

---

display_name String

Display name for the ACS user.

---

email String

Deprecated. use email_address.

---

email_address String

Email address of the ACS user.

---

errors List of Objects

Errors associated with the ACS user.

The specific structure of each object in this list depends on the value of its error_code field.

Variants:

deleted_externally

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

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• deleted_externally

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

salto_ks_subscription_limit_exceeded

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

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• salto_ks_subscription_limit_exceeded

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

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.

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• failed_to_create_on_acs_system

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

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.

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• failed_to_update_on_acs_system

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

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.

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• failed_to_delete_on_acs_system

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

latch_conflict_with_resident_user

Indicates that the ACS user was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam support.

created_at Datetime

Date and time at which Seam created the error.

---

error_code Enum

Enum values:

• latch_conflict_with_resident_user

---

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

---

external_type Enum

Brand-specific terminology for the ACS user type.

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 String

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

---

full_name String

Full name of the ACS user.

---

hid_acs_system_id UUID

---

is_managed Boolean

---

is_suspended Boolean

Indicates whether the ACS user is currently suspended.

---

pending_mutations List of Objects

Pending mutations associated with the ACS user. Seam is in the process of pushing these mutations to the integrated access system.

The specific structure of each object in this list depends on the value of its mutation_code field.

Variants:

creating

Seam is in the process of pushing a user creation to the integrated access system.

created_at Datetime

Date and time at which the mutation was created.

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• creating

deleting

Seam is in the process of pushing a user deletion to the integrated access system.

created_at Datetime

Date and time at which the mutation was created.

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• deleting

updating_user_information

created_at Datetime

Date and time at which the mutation was created.

---

from Object

Child Properties

• email_address String

• full_name String

• phone_number String

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• updating_user_information

---

to Object

Child Properties

• email_address String

• full_name String

• phone_number String

updating_access_schedule

Seam is in the process of pushing an access schedule update to the integrated access system.

created_at Datetime

Date and time at which the mutation was created.

---

from Object

Child Properties

• ends_at Datetime

• starts_at Datetime

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• updating_access_schedule

---

to Object

Child Properties

• ends_at Datetime

• starts_at Datetime

updating_suspension_state

Seam is in the process of pushing a suspension state update to the integrated access system.

created_at Datetime

Date and time at which the mutation was created.

---

from Object

Child Properties

• is_suspended Boolean

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• updating_suspension_state

---

to Object

Child Properties

• is_suspended Boolean

updating_group_membership

Seam is in the process of pushing an access group membership update to the integrated access system.

created_at Datetime

Date and time at which the mutation was created.

---

from Object

Old access group membership.

Child Properties

• acs_access_group_id UUID

  Old access group ID.

---

message String

Detailed description of the mutation.

---

mutation_code Enum

Enum values:

• updating_group_membership

---

to Object

New access group membership.

Child Properties

• acs_access_group_id UUID

  New access group ID.

---

phone_number String

Phone number of the ACS user in E.164 format (for example, [phone]).

---

user_identity_email_address String

Email address of the user identity associated with the ACS user.

---

user_identity_full_name String

Full name of the user identity associated with the ACS user.

---

user_identity_id String

ID of the user identity associated with the ACS user.

---

user_identity_phone_number String

Phone number of the user identity associated with the ACS user in E.164 format (for example, [phone]).

---

warnings List of Objects

Warnings associated with the ACS user.

The specific structure of each object in this list depends on the value of its warning_code field.

Variants:

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.

created_at Datetime

Date and time at which Seam created the warning.

---

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

---

warning_code Enum

Enum values:

• being_deleted

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.

created_at Datetime

Date and time at which Seam created the warning.

---

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

---

warning_code Enum

Enum values:

• 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.

created_at Datetime

Date and time at which Seam created the warning.

---

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

---

warning_code Enum

Enum values:

• unknown_issue_with_acs_user

latch_resident_user

Indicates that the ACS user was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.

created_at Datetime

Date and time at which Seam created the warning.

---

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

---

warning_code Enum

Enum values:

• latch_resident_user

---

workspace_id 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.

---

latch_conflict_with_resident_user

Indicates that the ACS user was created from the Seam API but also exists on Mission Control. This is unsupported. 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.

---

latch_resident_user

Indicates that the ACS user was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.

---

Events

acs_user.created

An access system user was created.

Properties

acs_system_id UUID

ID of the access system.

acs_user_id UUID

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_user.created

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

acs_user.deleted

An access system user was deleted.

Properties

acs_system_id UUID

ID of the access system.

acs_user_id UUID

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_user.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

Endpoints

/acs/users/add_to_access_group

Adds a specified access system user to a specified access group.

/acs/users/create

Creates a new access system user.

/acs/users/delete

Deletes a specified access system user and invalidates the access system user's credentials.

/acs/users/get

Returns a specified access system user.

/acs/users/list

Returns a list of all access system users.

/acs/users/list_accessible_entrances

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

/acs/users/remove_from_access_group

Removes a specified access system user from a specified access group.

/acs/users/revoke_access_to_all_entrances

Revokes access to all entrances for a specified access system user.

/acs/users/suspend

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

/acs/users/unsuspend

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

/acs/users/update

Updates the properties of a specified access system user.