Credentials

Means by which a user gains access at an entrance

The acs_credential object represents a credential that enables an ACS user to access one or more entrances 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.

acs_credential Properties

The acs_credential object has the following properties:

PropertyTypeDescription

acs_credential_id

String (UUID) Required

ID of the credential

acs_user_id

String (UUID) Optional

ID of the user to whom the credential belongs

acs_system_id

String (UUID) Required

ID of the access control system that contains the credential

parent_acs_credential_id

String (UUID) Optional

ID of the parent credential

display_name

String Optional

Display name that corresponds to the credential type

code

String Optional

Access (PIN) code for the credential

access_method

Enum (string) Required

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

external_type

Enum (string) Optional

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

external_type_display_name

String Optional

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

created_at

String Required

Date and time at which the credential was created

workspace_id

String (UUID) Required

ID of the workspace that contains the credential

starts_at

String (datetime) Optional

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

ends_at

String (datetime) Optional

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

is_multi_phone_sync_credential

Boolean Optional

Indicates whether the credential is a multi-phone sync credential

XXX_metadata

Object Optional

ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer

acs_credential Methods

You can perform the following actions on acs_credential objects:

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.