This endpoint is used to get all the cloud keys for a given user.
Response Payload Object
The response's payload will contain an array of objects containing the following values.
Property | Type | Description |
|---|---|---|
expireOn | DateTime | The expiration of that cloud key. |
id | integer | The Id of that cloud key. |
sendByEmail | boolean | Whether or not that cloud key was sent by email. |
sendByText | boolean | Whether or not that cloud key was sent by SMS message. |
status | integer | Whether or not that cloud key is active. Values can be 0 for inactive or 1 for active. Even if a cloud key is expired, it may still show as active. |
useOneTime | boolean | Whether or not that cloud key was only valid for one use. |
userId | Guid | The user for whom that cloud key belongs. |
validFrom | DateTime | The start date and time when that cloud key was usable. |
Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.
Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.
Controlled Errors
Error Code | Error Message |
|---|---|
error_cloud_key_out_of_time_rage | To DateTime provided is after the From DateTime provided. |
Any status codes returned that are not provided here are generic status codes that can be found here.