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.
Format: Enum
Access method for the credential. Supported values: code, card, mobile_key.
Possible enum values:
codecardmobile_key
Format: UUID
ID of the credential.
Format: UUID
Format: UUID
ID of the access control system that contains the credential.
Format: UUID
ID of the ACS user to whom the credential belongs.
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
Format: String
Number of the card associated with the credential.
Format: String
Access (PIN) code for the credential.
Format: Datetime
Date and time at which the credential was created.
Format: String
Display name that corresponds to the credential type.
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.
Format: List
Item format: Object
Errors associated with the credential.
error_code Format: String
message Format: String
Format: Enum
Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.
Possible enum values:
pti_cardbrivo_credentialhid_credentialvisionline_cardsalto_ks_credentialassa_abloy_vostio_keysalto_space_key
Format: String
Display name that corresponds to the brand-specific terminology for the credential type.
Format: Boolean
Indicates whether the credential has been encoded onto a card.
Format: Boolean
Indicates whether the latest state of the credential has been synced from Seam to the provider.
Format: Boolean
Format: Boolean
Indicates whether the credential is a multi-phone sync credential.
Format: Boolean
Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.
Format: Datetime
Date and time at which the credential was encoded onto a card.
Format: Datetime
Date and time at which the state of the credential was most recently synced from Seam to the provider.
Format: UUID
ID of the parent credential.
Format: String
Date and time at which the credential validity starts, in ISO 8601 format.
Format: Object
Visionline-specific metadata for the credential.
auto_join Format: Boolean
card_function_type Format: Enum
Possible enum values:
gueststaff
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
Format: List
Item format: Object
Warnings associated with the credential.
Format: UUID
ID of the workspace that contains the credential.
Indicates that the credential is waiting to be issued.
Indicates that the schedule of one of the credential's children was modified externally.
Indicates that the schedule of the credential was modified to avoid creating a credential with a start date in the past.
Indicates that the credential is being deleted.
An unknown issue occurred while syncing the state of the credential with the provider. This issue may affect the proper functioning of the credential.
Access permissions for the credential have changed. Reissue (re-encode) the credential. This issue may affect the proper functioning of the credential.
Assigns a specified credential to a specified ACS user.
Creates a new credential for a specified ACS user.
Deletes a specified credential.
Returns a specified credential.
Returns a list of all credentials.
Returns a list of all entrances to which a credential grants access.
Unassigns a specified credential from a specified ACS user.
Updates the code and ends at date and time for a specified credential.
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.
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.
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.