List roles

Prev Next
Get
/v1alpha/roles

Returns a list of all roles available in the workspace.

Security
HTTP
Type bearer
Responses
200

Roles listed successfully.

Expand All
object
roles
Array of object (apirolesv1alphaRole)
object

Role object

id
string (uuid)

The unique identifier of the role.

Example74e19393-3e94-48d2-8b60-26f2d2665942
name
string

The name of the role.

description
string

The description of the role.

scope_names
Array of string

The permissions (scopes) assigned to the role.

string
is_custom
boolean

The indication if the role is custom or not. This is 'true' if the role is a custom role.

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object