Sign in

v1

latestOpenAPI 3.0.02026-07-22201291.8 MB
/acs

Create a Credential for an ACS User

Creates a new credential for a specified ACS user. For granting access, we recommend Access Grants instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.

post/acs/credentials/create

Request body

access_method'code' | 'card' | 'mobile_key' | 'cloud_key' required

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

acs_system_idstring uuid

ID of the access system to which the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

acs_user_idstring uuid

ID of the access system user to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

allowed_acs_entrance_idsstring[]

Set of IDs of the entrances for which the new credential grants access.

codestring

Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.

credential_manager_acs_system_idstring uuid

ACS system ID of the credential manager for the new credential.

ends_atstring date-time

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

is_multi_phone_sync_credentialboolean

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

starts_atstring date-time

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

user_identity_idstring uuid

ID of the user identity to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id. If the access system contains a user with the same email_address or phone_number as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.

Response

OK