Skip to main content

​
The acs_user Object

Represents a user in an access system. An access system 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 users in your access system, see the corresponding system integration guide.
An access system user resource.
{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
  "acs_user_id": "6a5d9697-3cc4-436a-8165-4375ff424870",
  "connected_account_id": "c0175797-30f0-49f7-a228-2df115443ca7",
  "created_at": "2025-06-15T16:54:17.946482Z",
  "display_name": "Jane Doe",
  "email_address": "jane@example.com",
  "errors": [],
  "external_type": "salto_site_user",
  "external_type_display_name": "Salto site user",
  "full_name": "Jane Doe",
  "hid_acs_system_id": "2acbe47f-612c-422a-9205-7af292f74e7f",
  "is_managed": true,
  "is_suspended": false,
  "last_successful_sync_at": "2025-06-18T17:45:00.582Z",
  "pending_mutations": [
    {
      "to": { "acs_access_group_id": "2c0fb4a0-2b42-4651-926e-1a10bedbf6ce" },
      "from": { "acs_access_group_id": "f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f" },
      "message": "This user's access membership is being updated.",
      "created_at": "2025-06-18T17:57:01.867Z",
      "mutation_code": "updating_group_membership"
    }
  ],
  "phone_number": "+1555551000",
  "user_identity_email_address": "jane@example.com",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
  "user_identity_phone_number": "+1555551000",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}

​
Properties

access_schedule Object starts_at and ends_at timestamps for the access system user’s access.
acs_system_id UUID ID of the access system that contains the access system user.
acs_user_id UUID ID of the access system user.
connected_account_id UUID The ID of the connected account that is associated with the access system user.
created_at Datetime Date and time at which the access system user was created.
display_name String Display name for the access system user.
email String
Deprecated. use email_address.
email_address String Email address of the access system user.
errors List of Objects Errors associated with the access system user. The specific structure of each object in this list depends on the value of its error_code field. Variants:
external_type Enum Brand-specific terminology for the access system user type.
external_type_display_name String Display name that corresponds to the brand-specific terminology for the access system user type.
full_name String Full name of the access system user.
hid_acs_system_id UUID
is_managed Boolean
is_suspended Boolean Indicates whether the access system user is currently suspended.
pending_mutations List of Objects Pending mutations associated with the access system 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:
phone_number String Phone number of the access system user in E.164 format (for example, +15555550100).
salto_space_metadata Object Salto Space-specific metadata associated with the access system user.
user_identity_email_address String Email address of the user identity associated with the access system user.
user_identity_full_name String Full name of the user identity associated with the access system user.
user_identity_id String ID of the user identity associated with the access system user.
user_identity_phone_number String Phone number of the user identity associated with the access system user in E.164 format (for example, +15555550100).
warnings List of Objects Warnings associated with the access system user. The specific structure of each object in this list depends on the value of its warning_code field. Variants:
workspace_id UUID ID of the workspace that contains the access system user.

​
Errors

deleted_externally Indicates that the access system user was deleted from the access system outside of Seam.
failed_to_create_on_acs_system Indicates that the access system user was not created on the access system. This is likely due to an internal unexpected error. Contact Seam support.
failed_to_delete_on_acs_system Indicates that the access system user was not deleted on the access system. This is likely due to an internal unexpected error. Contact Seam support.
failed_to_update_on_acs_system Indicates that the access system user was not updated on the access system. This is likely due to an internal unexpected error. Contact Seam support.
latch_conflict_with_resident_user Indicates that the access system user was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam support.
salto_ks_subscription_limit_exceeded Indicates that the access system user could not be subscribed on Salto KS because the subscription limit has been exceeded.

​
Warnings

being_deleted Indicates that the access system user is being deleted from the access system. This is a temporary state, and the access system user will be deleted shortly.
latch_resident_user Indicates that the access system user was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
salto_ks_user_not_subscribed Indicates that the access system 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 access system user with the provider. This issue may affect the proper functioning of this user.

​
Events

acs_user.created An access system user was created.
acs_user.deleted An access system user was deleted.

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