ACS Users | Seam API Docs

Sign Up Supported Devices

The acs_user Object

Represents 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_schedule: [example value],
  acs_system_id: [example value],
  acs_user_id: [example value],
  created_at: [example value],
  display_name: [example value],
  email: [example value],
  email_address: [example value],
  errors: [example value],
  external_type: [example value],
  external_type_display_name: [example value],
  full_name: [example value],
  hid_acs_system_id: [example value],
  is_managed: [example value],
  is_suspended: [example value],
  pending_mutations: [example value],
  phone_number: [example value],
  user_identity_email_address: [example value],
  user_identity_full_name: [example value],
  user_identity_id: [example value],
  user_identity_phone_number: [example value],
  warnings: [example value],
  workspace_id: [example value]
}

Properties

access_schedule Object

Child Properties

ends_at Datetime

starts_at Datetime

acs_system_id UUID

acs_user_id UUID

created_at Datetime

display_name String

email String

Deprecated. use email_address.

email_address String

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

Variants:

deleted_externally

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

salto_ks_subscription_limit_exceeded

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

failed_to_create_on_acs_system

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

failed_to_update_on_acs_system

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

failed_to_delete_on_acs_system

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

latch_conflict_with_resident_user

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

message String

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

external_type Enum

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

full_name String

hid_acs_system_id UUID

is_managed Boolean

is_suspended Boolean

pending_mutations List of Objects

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

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

updating_user_information

created_at Datetime

Date and time at which the mutation was created.

from Object

message String

Detailed description of the mutation.

mutation_code Enum

to Object

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

message String

Detailed description of the mutation.

mutation_code Enum

to Object

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

message String

Detailed description of the mutation.

mutation_code Enum

to Object

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.

message String

Detailed description of the mutation.

mutation_code Enum

to Object

New access group membership.

phone_number String

user_identity_email_address String

user_identity_full_name String

user_identity_id String

user_identity_phone_number String

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

Variants:

being_deleted

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

salto_ks_user_not_subscribed

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

unknown_issue_with_acs_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

latch_resident_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

workspace_id UUID

Errors

deleted_externally

salto_ks_subscription_limit_exceeded

failed_to_create_on_acs_system

failed_to_update_on_acs_system

failed_to_delete_on_acs_system

latch_conflict_with_resident_user

Warnings

being_deleted

salto_ks_user_not_subscribed

unknown_issue_with_acs_user

latch_resident_user

Events

acs_user.created

Properties

acs_system_id UUID

acs_user_id UUID

connected_account_id UUID

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

acs_user.deleted

Properties

acs_system_id UUID

acs_user_id UUID

connected_account_id UUID

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

Endpoints