Sign in

v1

latestOpenAPI 3.0.02026-08-0417295208.0 KB
groups

Create a new group

post/groups

Request body

namestring required

the name of the group

descriptionstring required

the description of the group

Example request

{
  "name": "ui-team",
  "description": "ui-team description"
}

Response

successfully created the group

idstring

uid

namestring

the name of the group

descriptionstring

the description of the group

members_countinteger

member count

created_atstring

when the group was created

updated_atstring

when the group was updated

user_permission'read' | 'manage'

permissions types for users

  • "read" - the group member can only view within the group
  • "manage" - the group member can both view and edit group and update users
remoteboolean

remote group

Example response

{
  "name": "ui-team",
  "description": "ui-team owner access",
  "members_count": 1
}