Skip to main content

Update a role

PATCH /api/roles/:role_id updates the identified role resource

Required scope: scopes:manage:all

Path Parameters
role_id string REQUIRED
Request Body REQUIRED
role object
id string
name string
scopes object[]
id string
name string
public boolean
Responses
200
Schema OPTIONAL
data object OPTIONAL
id string OPTIONAL
name string OPTIONAL
scopes object[] OPTIONAL
id string OPTIONAL
name string OPTIONAL
public boolean OPTIONAL
400

Bad request.

Schema OPTIONAL
errors object OPTIONAL
401

The client is unauthorized to access this resource.

Schema OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema OPTIONAL
code string
message string
404

The requested resource could not be found.

Schema OPTIONAL
code string
message string
422

The request payload is invalid.

Schema OPTIONAL
errors object OPTIONAL