List available permissions

Beta
<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> `Organisation.Permission` + `List` <div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info> Returns the catalog of permissions usable in this Workspace, excluding deleted permissions. Deprecated permissions are still returned with `deprecated_at` populated, so consumers can surface end-of-life warnings. The catalog isn't paginated. Use `my` in place of a numeric `orgId` to target the caller's own Workspace.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

orgIdinteger or enumRequired

Workspace identifier. Either a positive integer organization ID, or the literal string my to target the caller’s own Workspace.

Response

Successful response.
iddouble
Unique permission identifier.
resourcestring
Resource the permission applies to.
actionstring
Action the permission grants on the resource.
created_atstringformat: "date-time"
When the permission was created.
updated_atstringformat: "date-time"
When the permission was last updated.
deprecated_atstring or nullformat: "date-time"

Set once the permission is end-of-life. The permission is still returned so clients can warn users, but it can’t be assigned to new or updated custom roles.

entrypointsobject

API entrypoints guarded by this permission, grouped into rest and graphql. Both arrays are always present, and empty when the permission guards no entrypoint of that kind.

Errors

404
Not Found Error