v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

Roles

Partially update role

Partially update a role object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/role/{role_id}

Path parameters

role_idstring uuid required

Role id

Request body

descriptionstring nullable

Textual description of the role

namestring nullable

Name of the role

add_member_rolesstring[] nullable

A list of role IDs to add to the role's inheriting-from set

remove_member_rolesstring[] nullable

A list of role IDs to remove from the role's inheriting-from set

Response

Returns the role object

idstring uuid required

Unique identifier for the role

org_idstring uuid nullable

Unique id for the organization that the role belongs under

A null org_id indicates a system role, which may be assigned to anybody and inherited by any other role, but cannot be edited.

It is forbidden to change the org after creating a role

user_idstring uuid nullable

Identifies the user who created the role

createdstring date-time nullable

Date of role creation

namestring required

Name of the role

descriptionstring nullable

Textual description of the role

deleted_atstring date-time nullable

Date of role deletion, or null if the role is still active

member_rolesstring[] nullable

Ids of the roles this role inherits from

An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions