List Credentials
Get all credentials
Returns a list of all credentials.
/acs/credentials/list
OK
Request
Filter the list of returned credentials by ACS user, access control system, or user identity by including one or more of the acs_user_id
, acs_system_id
, or user_identity_id
parameters, respectively, in the request body. You can also include the is_multi_phone_sync_credential
parameter.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String (UUID) Optional | ID of the user for which you want to retrieve all credentials |
| String (UUID) Optional | ID of the access control system for which you want to retrieve all credentials |
| String (UUID) Optional | ID of the user identity for which you want to retrieve all credentials |
| Boolean Optional | Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials |
Sample Request
Response
Returns an acs_credentials
array, in which each returned acs_credential
contains the following properties:
Property | Description |
---|---|
| ID of the credential |
| ID of the user to whom the credential belongs |
| Display name that corresponds to the credential type |
| Access (PIN) code for the credential |
| ID of the access control system that contains the credential |
| Access method for the credential. Supported values: |
| Brand-specific terminology for the credential type |
| Display name that corresponds to the brand-specific terminology for the credential type |
| ID of the workspace that contains the credential |
| Date and time at which the credential was created |
| Indicates whether the credential is a multi-phone sync credential |
| Date and time at which the credential validity starts, in ISO 8601 format |
| Date and time at which the credential validity ends, in ISO 8601 format |
| ACS manufacturer-specific metadata for the credential, where |
Sample Response
This response contains manufacturer-specific metadata that may vary by manufacturer.
Last updated