List Permissions

See every permission you can build a role or an API key from, and which of them a custom role may carry. Use the keys in Create Role, Update Role, and Create API Key.

GET

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

keystring

The permission key, such as workflow:run. Roles, API keys, and the effective permissions of a member name permissions by key.

namestring

The permission's display name.

areastring

The part of MindCloud it governs: the key before its first colon, such as workflow or member.

assignableToCustomRolesboolean

True when a custom role may carry it (Create Role, Update Role).

ownerOnlyboolean

True when only the built-in Owner role holds it; no custom role may carry it.

apiKeyGrantableboolean

True when an API key may hold it (Create API Key).