Create a Credential for a User
Create a new credential for a specified ACS user
Creates a new credential for a specified ACS user.
/acs/credentials/create
OK
Request
Specify the user to which the new credential belongs and the access method for the new credential by including the corresponding acs_user_id
and access_method
in the request body. You can also specify additional parameters, such as a code
for the credential. Note that the access_method
determines the additional required and useful parameters.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String (UUID) Required | ID of the user to whom the new credential belongs |
| Enum (string) Required | Access method for the new credential. Supported values: |
| String Optional | Access (PIN) code for the new credential There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide. |
| Boolean Optional | Indicates whether the new credential is a multi-phone sync credential |
| Array of strings (UUIDs) Optional | Set of IDs of the entrances for which the new credential grants access |
| Enum (string) Optional | ACS system ID of the credential manager for the new user |
| Object Optional | ACS manufacturer-specific metadata for the new credential, where |
| Datetime Optional | Date and time at which the validity of the new credential starts, in ISO 8601 format. |
| Datetime Optional | 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 |
Sample Request
PIN Code-Based Credential
Key Card-Based Credential
Seam Mobile Key
This request contains manufacturer-specific metadata that may vary by manufacturer.
Response
Returns an acs_credential
containing 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