Assign a Credential to an ACS User

Assigns a specified credential to a specified access system user.

POST /acs/credentials/assign

JavaScript

Seam SDK

await seam.acs.credentials.assign({
  user_identity_id: "1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01",
  acs_credential_id: "59c9af06-7881-46d2-8d9b-3eda964c058b",
});

/*
// void
*/

200

{
  "acs_credential": {
    "access_method": "code",
    "acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assa_abloy_vostio_metadata": {
      "auto_join": true,
      "door_names": [
        "<string>"
      ],
      "endpoint_id": "<string>",
      "key_id": "<string>",
      "key_issuing_request_id": "<string>",
      "override_guest_acs_entrance_ids": [
        "<string>"
      ]
    },
    "card_number": "<string>",
    "code": "<string>",
    "ends_at": "<string>",
    "external_type": "pti_card",
    "external_type_display_name": "<string>",
    "is_issued": true,
    "is_latest_desired_state_synced_with_provider": true,
    "is_multi_phone_sync_credential": true,
    "is_one_time_use": true,
    "issued_at": "2023-11-07T05:31:56Z",
    "latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
    "parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visionline_metadata": {
      "card_function_type": "guest",
      "auto_join": true,
      "card_id": "<string>",
      "common_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "credential_id": "<string>",
      "guest_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_valid": true,
      "joiner_acs_credential_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  },
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

acs_credential_id · string<uuid> · required

ID of the credential that you want to assign to an access system user.

acs_user_id · string<uuid>

ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.

user_identity_id · string<uuid>

ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS 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 ACS user. If the ACS system does not have a corresponding ACS user, one is created.

Response

200

application/json

OK

acs_credential · object · required

Means by which an access control system user gains access at an entrance. The acs_credential object represents a credential that provides an ACS user access within an...

Show child attributes

ok · boolean · required