Assign a Credential to a User

Assign a specified credential to a specified ACS user

Assigns a specified credential to a specified ACS user.

/acs/credentials/assign

post

Assigns a specified credential to a specified access system user.

Authorizations

Body

acs_user_idstring · uuidOptional

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_idstring · uuidOptional

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.

acs_credential_idstring · uuidRequired

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

Responses

200

application/json

400

Bad Request

401

Unauthorized

post

POST /acs/credentials/assign HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "acs_credential": {
    "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
    "display_name": "text",
    "code": "text",
    "is_one_time_use": true,
    "card_number": "text",
    "is_issued": true,
    "issued_at": "2025-07-01T03:06:19.739Z",
    "access_method": "code",
    "external_type": "pti_card",
    "external_type_display_name": "text",
    "created_at": "2025-07-01T03:06:19.739Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "starts_at": "text",
    "ends_at": "text",
    "errors": [
      {
        "error_code": "text",
        "message": "text"
      }
    ],
    "warnings": [
      {
        "created_at": "2025-07-01T03:06:19.739Z",
        "message": "text",
        "warning_code": "waiting_to_be_issued"
      }
    ],
    "is_multi_phone_sync_credential": true,
    "is_latest_desired_state_synced_with_provider": true,
    "latest_desired_state_synced_with_provider_at": "2025-07-01T03:06:19.739Z",
    "visionline_metadata": {
      "card_function_type": "guest",
      "joiner_acs_credential_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "guest_acs_entrance_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "common_acs_entrance_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "is_valid": true,
      "auto_join": true,
      "card_id": "text",
      "credential_id": "text"
    },
    "assa_abloy_vostio_metadata": {
      "auto_join": true,
      "override_guest_acs_entrance_ids": [
        "text"
      ],
      "key_id": "text",
      "key_issuing_request_id": "text",
      "door_names": [
        "text"
      ],
      "endpoint_id": "text"
    },
    "is_managed": true
  },
  "ok": true
}

Request

Specify the desired user and credential by including the corresponding acs_user_id and acs_credential_id in the request body.

Request Body Parameters

Parameter

Type

Description

acs_user_id

String (UUID) Required

ID of the desired user

acs_credential_id

String (UUID) Required

ID of the desired credential

Sample Request

seam.acs.credentials.assign(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

curl -X 'POST' \
  'https://connect.getseam.com/acs/credentials/assign' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_credential_id": "66666666-6666-6666-6666-666666666666"
}'

await seam.acs.credentials.assign({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_credential_id: "66666666-6666-6666-6666-666666666666"
});

# Coming soon!

$seam->acs->credentials->assign(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_credential_id: "66666666-6666-6666-6666-66666666"
);

seam.CredentialsAcs.Assign(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsCredentialId: "66666666-6666-6666-6666-66666666"
);

// Coming soon!

acs_credential, uErr := client.Acs.Credentials.Assign(
  context.Background(), &acs.CredentialsAssignRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
    AcsCredentialId: "66666666-6666-6666-6666-66666666",
  },
)

Response

Returns an acs_credential containing the following properties:

Property

Description

acs_credential_id

ID of the credential

acs_user_id

ID of the user to whom the credential belongs

display_name

Display name that corresponds to the credential type

code

Access (PIN) code for the credential

acs_system_id

ID of the access control system that contains the credential

access_method

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

external_type

Brand-specific terminology for the credential type

external_type_display_name

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

workspace_id

ID of the workspace that contains the credential

created_at

Date and time at which the credential was created

is_multi_phone_sync_credential

Indicates whether the credential is a multi-phone sync credential

starts_at

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

ends_at

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

XXX_metadata

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

Sample Response

This response contains manufacturer-specific metadata that may vary by manufacturer.

AcsCredential(
  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='11111111-1111-1111-1111-111111111111',
  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,
  # manufacturer-specific metadata
  )

{
  "acs_credential": {
    "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": "11111111-1111-1111-1111-111111111111",
    "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,
    # manufacturer-specific metadata
  },
  "ok": true
}

{
  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: '11111111-1111-1111-1111-111111111111',
  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,
  // manufacturer-specific metadata
}

# Coming soon!

{
  "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": "11111111-1111-1111-1111-111111111111",
  "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,
  // manufacturer-specific metadata
}

{
  "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": "11111111-1111-1111-1111-111111111111",
  "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,
  // manufacturer-specific metadata
}

// Coming soon!

{
  "acs_credential": {
    "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": "11111111-1111-1111-1111-111111111111",
    "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,
    # manufacturer-specific metadata
  },
  "ok": true
}

PreviousCreate a Credential for a User NextList Credentials

Last updated 1 year ago

Was this helpful?