This endpoint is used to create a cloud key for a specified user and then send that cloud key to either the user's email or phone number. If the cloud key was created successfully, the Id of the cloud key will be returned.
If both sendByEmail and sendByText are false, then the cloud key will not be sent to the user.
Controlled Errors
Error Code | Error Message |
|---|---|
error_invalid_time_scope | Either the expiration was set to a past date and time or the validFrom field was set to a date and time after the expiration. |
error_invalid_dates | The user who the cloud key is being made for is a guest user and that guest user is not yet active. |
error_user_not_found | No user or guest user was found with the provided Id. |
error_first_name_and_last_name_required | First and Last name of user are required to create a cloud key. |
error_email_invalid_format | The email address of that user is in an invalid format. |
error_phonenumber_invalid_format | The phone number of that user is in an invalid format. |
error_creating_cloud_key | Failed to create the cloud key. |
Any status codes returned that are not provided here are generic status codes that can be found here.