Update a role

Prev Next
Put
/v1alpha/roles/{role_id}

Modifies the specified role. For a full list of scopes, make a 'List roles' request or refer to our documentation.

Security
HTTP
Type bearer
Path parameters
role_id
string (uuid) Required

The ID of the role to update. To get a list of role IDs make a List roles request.

Body parameters
object
role_description
string

The updated description of the role.

scope_names
Array of string

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

string
Responses
200

Role updated successfully.

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.

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
404

Role not found.

object