Credentials

acs_credential

Means by which a 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 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: ID

ID of the credential.

---

acs_credential_pool_id

Format: ID

---

acs_system_id

Format: ID

ID of the access control system that contains the credential.

---

acs_user_id

Format: ID

ID of the ACS user to whom the credential belongs.

---

card_number

Format: String

---

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

Errors associated with the acs_credential.

---

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

---

external_type_display_name

Format: String

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

---

is_issued

Format: Boolean

---

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

---

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: ID

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

card_id Format: string

common_acs_entrance_ids Format: list

credential_id Format: string

guest_acs_entrance_ids Format: list

is_valid Format: boolean

joiner_acs_credential_ids Format: list

---

warnings

Format: List

Warnings associated with the acs_credential.

---

workspace_id

Format: ID

ID of the workspace that contains 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.