const { result, error } = await unkey.permissions.getPermission({
  permissionId: "perm_123",
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}
console.log(result);
}
{
  "result": {
    "id": "perm_123",
    "name": "domain.record.manager",
    "description": "Can manage dns records"
  }
}
const { result, error } = await unkey.permissions.getPermission({
  permissionId: "perm_123",
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}
console.log(result);
}
{
  "result": {
    "id": "perm_123",
    "name": "domain.record.manager",
    "description": "Can manage dns records"
  }
}

To use this function, your root key must have the rbac.*.read_permission

​
Request

​
permissionId
string
required

The id of the permission to fetch

Minimum length: 1

Example: "perm_123"

​
Response

​
id
string
required

The id of the permission. This is used internally

Example: "perm_123"

​
name
string
required

The unique name of your permission.

Example: "domain.record.manager"

​
description
string

The description of what this permission does. This is just for your team, your users will not see this.

Example:"Can manage dns records."