---
title: "Generate new cloudKey unlock token for a specific entry."
method: POST
path: "/orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyUnlockToken"
tags: ["orgs/users"]
---

# Generate new cloudKey unlock token for a specific entry.

`POST /orgs/{orgId}/users/{userId}/credentials/{credentialId}/generateCloudKeyUnlockToken`

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

## Path parameters

- `orgId` integer, required
- `userId` integer, required
- `credentialId` integer, required

## Request body

- object
  - `entryId` integer
  - `entryData` object[]
    - `entryId` integer
    - `uiLabel` string
  - `notBefore` string, date, nullable
  - `expires` string, date, nullable
  - `description` string, nullable
  - `shorten` boolean

## Response `201`

Created

- object
  - `data` object
    - `cloudKeyUnlockToken` string
    - `apiUrl` string
    - `webUrl` string
    - `fullWebUrl` string
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.dev/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.dev/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)