Create a Credential for an ACS User
Creates a new credential for a specified ACS user.
Code
Specify the acs_user_id
and access_method
to create a new credential. You can also specify additional parameters, depending on the access_method
.
await seam.acs.credentials.create({
acs_user_id: "33333333-3333-3333-3333-333333333333",
access_method: "mobile_key",
allowed_acs_entrance_ids: [
"55555555-5555-5555-5555-555555555555",
"55555555-5555-5555-5555-000000000000",
],
credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
is_multi_phone_sync_credential: true,
starts_at: "2024-03-01T10:40:00Z",
ends_at: "2024-03-04T10:40:00Z",
});
Output
{
"acs_credential_id": "99999999-9999-9999-9999-999999999999",
"acs_user_id": "33333333-3333-3333-3333-333333333333",
"display_name": "Multi Phone Sync Credential",
"code": null,
"acs_system_id": "88888888-8888-8888-8888-888888888888",
"access_method": "mobile_key",
"workspace_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential": true
}
Request Parameters
access_method
String (Required)
Access method for the new credential. Supported values: code
, card
, mobile_key
.
acs_system_id
String
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_id
String
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_ids
Array of UUIDs
Set of IDs of the entrances for which the new credential grants access.
assa_abloy_vostio_metadata
Object
Vostio-specific metadata for the new credential.
code
String
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_id
String
ACS system ID of the credential manager for the new credential.
ends_at
String
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_credential
Boolean
Indicates whether the new credential is a multi-phone sync credential.
salto_space_metadata
Object
Salto Space-specific metadata for the new credential.
starts_at
String
Date and time at which the validity of the new credential starts, in ISO 8601 format.
user_identity_id
String
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.
visionline_metadata
Object
Visionline-specific metadata for the new credential.
Response
Examples
Last updated
Was this helpful?