v47

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

Groups

Partially update group

Partially update a group 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/group/{group_id}

Path parameters

group_idstring uuid required

Group id

Request body

descriptionstring nullable

Textual description of the group

namestring nullable

Name of the group

add_member_usersstring[] nullable

A list of user IDs to add to the group

remove_member_usersstring[] nullable

A list of user IDs to remove from the group

add_member_groupsstring[] nullable

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

remove_member_groupsstring[] nullable

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

Response

Returns the group object

idstring uuid required

Unique identifier for the group

org_idstring uuid required

Unique id for the organization that the group belongs under

It is forbidden to change the org after creating a group

user_idstring uuid nullable

Identifies the user who created the group

createdstring date-time nullable

Date of group creation

namestring required

Name of the group

descriptionstring nullable

Textual description of the group

deleted_atstring date-time nullable

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

member_usersstring[] nullable

Ids of users which belong to this group

member_groupsstring[] nullable

Ids of the groups this group inherits from

An inheriting group has all the users contained in its member groups, as well as all of their inherited users