Credentials

The acs_credential Object

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

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.

Properties

access_method Enum

Access method for the credential. Supported values: code, card, mobile_key.

Enum values

code
card
mobile_key

acs_credential_id UUID

ID of the credential.

acs_credential_pool_id UUID

acs_system_id UUID

ID of the access control system that contains the credential.

acs_user_id UUID

ID of the ACS user to whom the credential belongs.

assa_abloy_vostio_metadata Object

Vostio-specific metadata for the credential.

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

Number of the card associated with the credential.

code String

Access (PIN) code for the credential.

created_at Datetime

Date and time at which the credential was created.

display_name String

Display name that corresponds to the credential type.

ends_at String

Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

errors List of Objects

Errors associated with the credential.

Child Object Properties

error_code String

message String

external_type Enum

Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

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

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

is_issued Boolean

Indicates whether the credential has been encoded onto a card.

is_latest_desired_state_synced_with_provider Boolean

Indicates whether the latest state of the credential has been synced from Seam to the provider.

is_managed Boolean

is_multi_phone_sync_credential Boolean

Indicates whether the credential is a multi-phone sync credential.

is_one_time_use Boolean

Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

issued_at Datetime

Date and time at which the credential was encoded onto a card.

latest_desired_state_synced_with_provider_at Datetime

Date and time at which the state of the credential was most recently synced from Seam to the provider.

parent_acs_credential_id UUID

ID of the parent credential.

starts_at String

Date and time at which the credential validity starts, in ISO 8601 format.

visionline_metadata Object

Visionline-specific metadata for the credential.

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

warnings List of Objects

Warnings associated with the credential.

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

Variants:

waiting_to_be_issued

Indicates that the credential is 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.

Enum values:

waiting_to_be_issued

schedule_externally_modified

Indicates that the schedule of one of the credential's children was modified externally.

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.

Enum values:

schedule_externally_modified

schedule_modified

Indicates that the schedule of the credential was modified to avoid creating a credential with a start date in the past.

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.

Enum values:

schedule_modified

being_deleted

Indicates that the credential is 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.

Enum values:

being_deleted

unknown_issue_with_acs_credential

An unknown issue occurred while syncing the state of the credential with the provider. This issue may affect the proper functioning of the 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.

Enum values:

unknown_issue_with_acs_credential

needs_to_be_reissued

Access permissions for the credential have changed. Reissue (re-encode) the credential. This issue may affect the proper functioning of the 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.

Enum values:

needs_to_be_reissued

workspace_id UUID

ID of the workspace that contains the credential.

Warnings

waiting_to_be_issued

Indicates that the credential is waiting to be issued.

schedule_externally_modified

Indicates that the schedule of one of the credential's children was modified externally.

schedule_modified

Indicates that the schedule of the credential was modified to avoid creating a credential with a start date in the past.

being_deleted

Indicates that the credential is being deleted.

unknown_issue_with_acs_credential

An unknown issue occurred while syncing the state of the credential with the provider. This issue may affect the proper functioning of the credential.

needs_to_be_reissued

Access permissions for the credential have changed. Reissue (re-encode) the credential. This issue may affect the proper functioning of the credential.

Events

acs_credential.deleted

An ACS credential was deleted.

Properties

acs_credential_id UUID

ID of the affected credential.

acs_system_id UUID

ID of the access system.

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

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

acs_credential.issued

An ACS credential was issued.

Properties

acs_credential_id UUID

ID of the affected credential.

acs_system_id UUID

ID of the access system.

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

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

acs_credential.reissued

An ACS credential was reissued.

Properties

acs_credential_id UUID

ID of the affected credential.

acs_system_id UUID

ID of the access system.

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

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

acs_credential.invalidated

An ACS credential was invalidated. That is, the credential cannot be used anymore.

Properties

acs_credential_id UUID

ID of the affected credential.

acs_system_id UUID

ID of the access system.

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

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

Endpoints

/acs/credentials/assign

Assigns a specified credential to a specified access system user.

/acs/credentials/create

Creates a new credential for a specified ACS user.

/acs/credentials/delete

Deletes a specified credential.

/acs/credentials/get

Returns a specified credential.

/acs/credentials/list

Returns a list of all credentials.

/acs/credentials/list_accessible_entrances

Returns a list of all entrances to which a credential grants access.

/acs/credentials/unassign

Unassigns a specified credential from a specified access system user.

/acs/credentials/update

Updates the code and ends at date and time for a specified credential.

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

Last updated 6 days ago

Was this helpful?