orgs/users

Generate new cloudKey unlock token for a specific entry.

The response includes key fields with the following meanings:<br/><br/>cloudKeyUnlockToken: returns the unlock token authorized to unlock the specified entries.<br/><br/>apiUrl: returns the URL that, if POST-ed to, will immediately unlock the specified entries. E.g. curl -XPOST https://api.openpath.com/tokens/...<redacted-token>.../use immediately unlocks the specified entries.<br/><br/>fullWebUrl: returns the URL that if launched in a web browser will display a "Tap to Unlock an Entry:" set of buttons for each entry specified. E.g. browser browse to https://control.openpath.com/cloudKeyUnlock?token=...<redacted-token>...<br/><br/>webUrl: same functionality as fullWebUrl but uses a shortCode as the authorizing credential. This can be better for manual typing or other use-cases where a shorter URL provides value. E.g. browser browse to https://control.openpath.com/cloudKeyUnlock?shortCode=...<redacted-short-code>...<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-user{params.userId}:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>Endpoint name: generateCloudKeyUnlockToken

post/orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyUnlockToken

Path parameters

orgIdinteger required
userIdinteger required
credentialIdinteger required

Request body

entryIdinteger
notBeforestring date nullable
expiresstring date nullable
descriptionstring nullable
shortenboolean

Response

Created

Changes

No recorded changes to this endpoint across all 1 revision of this API.