Sign in
permissions

Get permission

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
post/v2/permissions.getPermission

Request body

permissionstring required

The unique identifier of the permission to retrieve. Must be a valid permission ID that begins with 'perm_' and exists within your workspace.

Example request

{
  "permission": "perm_1234567890abcdef"
}

Response

Permission retrieved successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "perm_1234567890abcdef",
    "name": "users.read",
    "slug": "users-read",
    "description": "Allows reading user profile information and account details"
  }
}

Changes

Changed in 4 of the 90 revisions of this API.115

  • 59efaed65ec4111See the full diff
    • ▲

      the permission request property's maxLength was decreased to 128

      request-property-max-length-decreased

    • ●

      changed the pattern of the request property permission from ^[a-zA-Z][a-zA-Z0-9._-]*$ to ^[a-zA-Z0-9_:\-\.\*]+$

      request-property-pattern-changed

    • ○

      the permission request property's minLength was decreased from 3 to 1

      request-property-min-length-decreased

  • 43ad1ce9a1522See the full diff
    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    • ○

      the endpoint scheme security rootKey was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 551df53dd45d1See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 9a9c22b6dd091See the full diff
    • ○

      api operation id getPermission removed and replaced with permissions.getPermission

      api-operation-id-removed