Get Permission

Auto-generate your docs

Retrieve details about a specific permission including its name, description, and metadata.

Required Permissions

Your root key must have the following permission:

rbac.*.read_permission

Request

string

required

The unique identifier of the permission to retrieve.Must be a valid permission ID that begins with ‘perm_’ and exists within your workspace.Pattern: ^[a-zA-Z][a-zA-Z0-9._-]*$Length: 3-255 charactersExample: perm_1234567890abcdef

Response

string

required

The unique identifier for this permission.

string

required

The permission name.

string

URL-safe identifier for the permission.

string

Description of what this permission grants access to.

integer

Unix timestamp in milliseconds when the permission was created.

integer

Unix timestamp in milliseconds when the permission was last updated.

Examples

curl -X POST https://api.unkey.com/v2/permissions.getPermission \
  -H "Authorization: Bearer <UNKEY_ROOT_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "permission": "perm_1234567890abcdef"
  }'

import { Unkey } from "@unkey/api";

const unkey = new Unkey({ token: process.env.UNKEY_ROOT_KEY });

const result = await unkey.permissions.getPermission({
  permission: "perm_1234567890abcdef",
});

console.log(result.result);

Response Example

{
  "meta": {
    "requestId": "req_1234abcd"
  },
  "data": {
    "id": "perm_1234567890abcdef",
    "name": "documents.read",
    "slug": "documents-read",
    "description": "Allows reading document resources",
    "createdAt": 1704067200000,
    "updatedAt": 1704067200000
  }
}

Overview

Keys

APIs

Rate Limiting

Identities

Analytics

Permissions

Get Permission

Required Permissions

Request

Response

Examples

Response Example

​Required Permissions

​Request

​Response

​Examples

​Response Example

Required Permissions

Request

Response

Examples

Response Example