To enable multi-factor authentication via push notification on a mobile device, the user resource must have a mobile device and an application associated with its user ID. The association is implemented with a pairing key.
The pairing key endpoints provide operations to create, read, and remove pairing key resources associated with a specified user ID, mobile device and application. The examples below show common actions to manage pairing keys.
| Property | Description |
|---|---|
_links.self |
The URL of the pairing key resource. |
_links.environment |
The URL of the environment resource. |
_links.user |
The URL of the user resource. |
id |
The resource ID. |
environment.id |
The environment ID. |
code |
The pairing key that the end users should use for pairing their device. |
status |
The status of the pairing key. Valid values:
|
applications |
The collection of application IDs that can be used with this pairing key. |
user.id |
The user ID. |
createdAt |
The date this pairing key was created. |
updatedAt |
The date this pairing key was updated. |
expiresAt |
The date this pairing key expires. |
| Code | Message |
|---|---|
| 200 | Successful operation. |
| 201 | Successfully created. |
| 204 | Successfully removed. No content. |
| 400 | The request could not be completed. |
| 401 | You do not have access to this resource. |
| 403 | You do not have permissions or are not licensed to make this request. |
| 404 | The requested resource was not found. |
| 500 | Unexpected server error. |