Credentials

The acs_credential Object

Means by which an gains access at an . The acs_credential object represents a that provides an ACS user access within an .

An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.

For each acs_credential, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.

{
  access_method: [example value],
  acs_credential_id: [example value],
  acs_credential_pool_id: [example value],
  acs_system_id: [example value],
  acs_user_id: [example value],
  assa_abloy_vostio_metadata: [example value],
  card_number: [example value],
  code: [example value],
  created_at: [example value],
  display_name: [example value],
  ends_at: [example value],
  errors: [example value],
  external_type: [example value],
  external_type_display_name: [example value],
  is_issued: [example value],
  is_latest_desired_state_synced_with_provider: [example value],
  is_managed: [example value],
  is_multi_phone_sync_credential: [example value],
  is_one_time_use: [example value],
  issued_at: [example value],
  latest_desired_state_synced_with_provider_at: [example value],
  parent_acs_credential_id: [example value],
  starts_at: [example value],
  visionline_metadata: [example value],
  warnings: [example value],
  workspace_id: [example value]
}

Properties

access_method Enum

Enum values

code
card
mobile_key

acs_credential_id UUID

acs_credential_pool_id UUID

acs_system_id UUID

acs_user_id UUID

assa_abloy_vostio_metadata Object

Child Properties

auto_join Boolean
door_names List of Strings
endpoint_id String
key_id String
key_issuing_request_id String
override_guest_acs_entrance_ids List of Strings

card_number String

code String

created_at Datetime

display_name String

ends_at String

errors List of Objects

Child Object Properties

error_code Stringmessage String

external_type Enum

Enum values

pti_card
brivo_credential
hid_credential
visionline_card
salto_ks_credential
assa_abloy_vostio_key
salto_space_key
latch_access

external_type_display_name String

is_issued Boolean

is_latest_desired_state_synced_with_provider Boolean

is_managed Boolean

is_multi_phone_sync_credential Boolean

is_one_time_use Boolean

issued_at Datetime

latest_desired_state_synced_with_provider_at Datetime

parent_acs_credential_id UUID

starts_at String

visionline_metadata Object

Child Properties

auto_join Boolean
card_function_type Enum

card_id String
common_acs_entrance_ids List of UUIDs
credential_id String
guest_acs_entrance_ids List of UUIDs
is_valid Boolean
joiner_acs_credential_ids List of UUIDs

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

Variants:

waiting_to_be_issued

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

schedule_externally_modified

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

schedule_modified

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

unknown_issue_with_acs_credential

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

needs_to_be_reissued

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

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

workspace_id UUID

Warnings

waiting_to_be_issued

schedule_externally_modified

schedule_modified

being_deleted

unknown_issue_with_acs_credential

needs_to_be_reissued

Events

acs_credential.deleted

Properties

acs_credential_id UUID

acs_system_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_credential.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

acs_credential.issued

Properties

acs_credential_id UUID

acs_system_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_credential.issued

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

acs_credential.reissued

Properties

acs_credential_id UUID

acs_system_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_credential.reissued

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

acs_credential.invalidated

Properties

acs_credential_id UUID

acs_system_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_credential.invalidated

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

Endpoints

PreviousList ACS Users in an Access Group NextCreate a Credential for an ACS User

Last updated 2 days ago

Was this helpful?