Sign UpSupported Devices
Edit

Create a Credential for an ACS User

Creates a new credential for a specified ACS user.

Creates a new PIN code credential for a specified access system user, using the associated user identity.

Code:

await seam.acs.credentials.create({
  credential_manager_acs_system_id: "bccb0d23-5107-498b-87a6-6a8aa929eeb2",
  user_identity_id: "4b6ec19d-ba68-46ca-80fd-55247684c2bb",
  acs_system_id: "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  access_method: "code",
  code: "1234",
  allowed_acs_entrance_ids: ["21805570-4706-4c21-99fc-3ed873a5e014"],
  starts_at: "2025-06-19T21:08:08.000Z",
  ends_at: "2025-06-23T12:35:01.000Z",
});

Output:

{
  "access_method": "code",
  "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
  "acs_system_id": "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  "acs_user_id": "53f39f90-5113-4bdd-8432-acf328ce508c",
  "code": "1234",
  "created_at": "2025-06-16T16:54:17.946514Z",
  "display_name": "Salto KS Credential",
  "errors": [],
  "external_type": "salto_ks_credential",
  "external_type_display_name": "Salto KS Credential",
  "is_latest_desired_state_synced_with_provider": true,
  "is_managed": true,
  "is_multi_phone_sync_credential": true,
  "is_one_time_use": false,
  "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
  "starts_at": "2025-06-19T21:08:08.000Z",
  "warnings": [],
  "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
}
Authentication Methods

  • API key

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

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.

auto_join Boolean

join_all_guest_acs_entrances Boolean

override_all_guest_acs_entrances Boolean

override_guest_acs_entrance_ids List

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.

assign_new_key Boolean

Indicates whether to assign a first, new card to a user. See also Programming Salto Space Card-based Credentials.

update_current_key Boolean

Indicates whether to update the user's existing card. See also Programming Salto Space Card-based Credentials.

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.

assa_abloy_credential_service_mobile_endpoint_id UUID

Deprecated. Read-only endpoint references moved to endpoint.

auto_join Boolean

card_format Enum

Enum values:

  • TLCode

  • rfid48

card_function_type Enum

Enum values:

  • guest

  • staff

is_override_key Boolean

Deprecated. Use override instead.

joiner_acs_credential_ids List

override Boolean

Response

Returns: acs_credential

Examples

Create a PIN code credential for an access system user

Creates a new PIN code credential for a specified access system user.

Code:

Output:

Create a card credential for a user identity

Creates a new card credential for a specified access system user, using the associated user identity.

Code:

Output:

Create a card credential for an access system user

Creates a new card credential for a specified access system user.

Code:

Output:

Create a mobile key credential for a user identity

Creates a new mobile key credential for a specified access system user, using the associated user identity.

Code:

Output:

Create a mobile key credential for an access system user

Creates a new mobile key credential for a specified access system user.

Code:

Output:

PreviousAssign a Credential to an ACS UserNextDelete a Credential

Last updated

Was this helpful?