The ACS User Object

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.

{
  "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

Object

starts_at and ends_at timestamps for the access system user’s access.

Show properties

String (ISO 8601)

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

String (ISO 8601)

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

String (UUID)

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

String (UUID)

ID of the access system user.

String (UUID)

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

String (ISO 8601)

Date and time at which the access system user was created.

String

Display name for the access system user.

String

deprecated

Deprecated. use email_address.The email.

String

Email address of the access system user.

Array

Errors associated with the access system user.

Enum (String)

Brand-specific terminology for the access system user type.

String

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

String

Full name of the access system user.

String (UUID)

ID of the HID access control system associated with the user.

Boolean

Indicates whether Seam manages the access system user.

Boolean

Indicates whether the access system user is currently suspended.

Array

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

String

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

Object

Salto Space-specific metadata associated with the access system user.

Show properties

Boolean

Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.

String

User ID in the Salto Space access system.

String

Email address of the user identity associated with the access system user.

String

Full name of the user identity associated with the access system user.

String

ID of the user identity associated with the access system user.

String

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

Array

Warnings associated with the access system user.

String (UUID)

ID of the workspace that contains the access system user.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The ACS User Object