Update a role

Required scope: roles:write

Updates a role in a workspace.

Path Params
string
required

Globally unique identifier for the role.

Query Params
opt_fields
array of strings

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

opt_fields
boolean

Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Body Params

The updated fields for the role.

data
object

A role represents a group of permissions that can be assigned to a user or team.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json