Skip to main content
PATCH
/
rbac
/
groups
/
{group_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "members": [
    {
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "added_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ],
  "member_count": 0
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Path Parameters

​
group_id
string<uuid>
required

Body

application/json

Update schema for a group.

​
name
string | null

Group name

Required string length: 1 - 128
​
description
string | null

Optional description of the group

Maximum string length: 512

Response

Successful Response

Read schema for a group with its members.

​
id
string<uuid>
required
​
name
string
required
​
organization_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
created_by
string<uuid> | null
​
members
GroupMemberRead · object[]
​
member_count
integer
default:0