Create Cloud Key

post

https://api.alocity.com/v1/integration-management/cloud-key

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.

Body Params

validFrom

date

required

The start date and time for which the cloud key will be usable.

expireOn

date

required

The date and time when this cloud key will expire.

sendByEmail

boolean

Whether or not to send the cloud key via email. If this value is not passed, it will default to false.

sendByText

boolean

Whether or not to send the cloud key via SMS message. If this value is not passed, it will default to false.

useOneTime

boolean

Whether or not this cloud key will be one time use only. If this value is not passed, it will default to false.

userId

string

The Guid Id of the user that the cloud key will be associated with. If this value is not passed, it will default to an empty Guid.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

400400