Update a Credential

Update the code for a specified credential

Updates the code for a specified credential (acs_credential object).

Request

Specify the desired credential and updated code by including the corresponding acs_credential_id and code parameters, respectively, in the request body.

Request Body Parameters

ParameterTypeDescription

acs_credential_id

String (UUID) Required

ID of the desired credential

code

String Required

Replacement access (PIN) code for the credential

Sample Request

seam.acs.credentials.update(
  acs_credential_id="66666666-6666-6666-6666-666666666666",
  code="7890"
)

Response

Returns an acs_credential containing the following properties:

PropertyDescription

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='7890',
  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
)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.