Create a role

Prev Next
Post
/v1alpha/roles

Creates a new role.

Security
HTTP
Type bearer
Body parameters
object
role_name
string

The name of the role being created. The name must be unique within the workspace.

role_description
string

The description of the role being created.

scope_names
Array of string

The permissions (scopes) to assign to the new role. For a full list of scopes, run the 'List roles' call or refer to our documentation.

string
Responses
200

A successful response.

Expand All
object
role
object (apirolesv1alphaRole)

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.

201

Role created successfully.

object
400

Invalid request format or parameters.

object
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
429

Resource exhausted.

object