Credentials

`acs_credential`

Means by which an ACS user gains access at an entrance. The acs_credential object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a PIN code.

`access_method`

Format: Enum

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

Possible enum values:

code
card
mobile_key

`acs_credential_id`

Format: UUID

ID of the credential.

`acs_credential_pool_id`

Format: UUID

`acs_system_id`

Format: UUID

ID of the access control system that contains the credential.

`acs_user_id`

Format: UUID

ID of the ACS user to whom the credential belongs.

`assa_abloy_vostio_metadata`

Format: Object

Vostio-specific metadata for the credential.

door_names Format: List Item format: String

endpoint_id Format: String

key_id Format: String

key_issuing_request_id Format: String

override_guest_acs_entrance_ids Format: List Item format: String

`card_number`

Format: String

Number of the card associated with the credential.

`code`

Format: String

Access (PIN) code for the credential.

`created_at`

Format: Datetime

Date and time at which the credential was created.

`display_name`

Format: String

Display name that corresponds to the credential type.

`ends_at`

Format: 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`

Format: List

Item format: Object

Errors associated with the credential.

error_code Format: String

message Format: String

`external_type`

Format: Enum

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

Possible enum values:

pti_card
brivo_credential
hid_credential
visionline_card
salto_ks_credential
assa_abloy_vostio_key
salto_space_key

`external_type_display_name`

Format: String

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

`is_issued`

Format: Boolean

Indicates whether the credential has been encoded onto a card.

`is_latest_desired_state_synced_with_provider`

Format: Boolean

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

`is_managed`

Format: Boolean

`is_multi_phone_sync_credential`

Format: Boolean

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

`is_one_time_use`

Format: Boolean

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

`issued_at`

Format: Datetime

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

`latest_desired_state_synced_with_provider_at`

Format: Datetime

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

`parent_acs_credential_id`

Format: UUID

ID of the parent credential.

`starts_at`

Format: String

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

`visionline_metadata`

Format: Object

Visionline-specific metadata for the credential.

auto_join Format: Boolean

card_function_type Format: Enum

Possible enum values:

guest
staff

card_id Format: String

common_acs_entrance_ids Format: List Item format: UUID

credential_id Format: String

guest_acs_entrance_ids Format: List Item format: UUID

is_valid Format: Boolean

joiner_acs_credential_ids Format: List Item format: UUID

`warnings`

Format: List

Item format: Object

Warnings associated with the credential.

`workspace_id`

Format: 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.

Endpoints

`/acs/credentials/assign`

Assigns a specified credential to a specified ACS 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 ACS user.

`/acs/credentials/update`

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

Events

`acs_credential.deleted`

An ACS credential was deleted.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

`acs_credential.issued`

An ACS credential was issued.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

`acs_credential.reissued`

An ACS credential was reissued.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

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

Last updated 8 days ago

Was this helpful?

Credentials

`acs_credential`

`access_method`

Format: Enum

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

Possible enum values:

code
card
mobile_key

`acs_credential_id`

Format: UUID

ID of the credential.

`acs_credential_pool_id`

Format: UUID

`acs_system_id`

Format: UUID

ID of the access control system that contains the credential.

`acs_user_id`

Format: UUID

ID of the ACS user to whom the credential belongs.

`assa_abloy_vostio_metadata`

Format: Object

Vostio-specific metadata for the credential.

door_names Format: List Item format: String

endpoint_id Format: String

key_id Format: String

key_issuing_request_id Format: String

override_guest_acs_entrance_ids Format: List Item format: String

`card_number`

Format: String

Number of the card associated with the credential.

`code`

Format: String

Access (PIN) code for the credential.

`created_at`

Format: Datetime

Date and time at which the credential was created.

`display_name`

Format: String

Display name that corresponds to the credential type.

`ends_at`

Format: 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`

Format: List

Item format: Object

Errors associated with the credential.

error_code Format: String

message Format: String

`external_type`

Format: Enum

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

Possible enum values:

pti_card
brivo_credential
hid_credential
visionline_card
salto_ks_credential
assa_abloy_vostio_key
salto_space_key

`external_type_display_name`

Format: String

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

`is_issued`

Format: Boolean

Indicates whether the credential has been encoded onto a card.

`is_latest_desired_state_synced_with_provider`

Format: Boolean

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

`is_managed`

Format: Boolean

`is_multi_phone_sync_credential`

Format: Boolean

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

`is_one_time_use`

Format: Boolean

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

`issued_at`

Format: Datetime

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

`latest_desired_state_synced_with_provider_at`

Format: Datetime

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

`parent_acs_credential_id`

Format: UUID

ID of the parent credential.

`starts_at`

Format: String

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

`visionline_metadata`

Format: Object

Visionline-specific metadata for the credential.

auto_join Format: Boolean

card_function_type Format: Enum

Possible enum values:

guest
staff

card_id Format: String

common_acs_entrance_ids Format: List Item format: UUID

credential_id Format: String

guest_acs_entrance_ids Format: List Item format: UUID

is_valid Format: Boolean

joiner_acs_credential_ids Format: List Item format: UUID

`warnings`

Format: List

Item format: Object

Warnings associated with the credential.

`workspace_id`

Format: 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.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

`acs_credential.issued`

An ACS credential was issued.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

`acs_credential.reissued`

An ACS credential was reissued.

acs_credential_id Format: UUID

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

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

Last updated 8 days ago

Was this helpful?