Get a Permission

The ability to perform an action on an object, enabling the corresponding functionality in the UI and API. e.g. workspaces:create, vcs-providers:read.

The ID of a permission consist of two parts separated with : (colon):

• Resource type in a plural form.
• Action name. Generally the actions are CRUD, but some objects have specific actions, such as runs:cancel.

If an * (asterisk) is used instead of the action name in the permission it means the permission allows all actions for the specified resource type. For example workspaces:* allows all actions with workspaces.

An asterisk can be also used instead of the resource type. For example permission *:read gives read access to all resources.

*:* - gives access to everything.

Use List Permissions to obtain all possible permissions.