Sign in

v47

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

Create or replace group

Create or replace group. If there is an existing group with the same name as the one specified in the request, will replace the existing group with the provided fields

put/v1/group

Request body

namestring required

Name of the group

descriptionstring nullable

Textual description of the group

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

org_namestring nullable

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the group belongs in.

Response

Returns the new 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