Skip to main content
POST
Create group

Authorizations

Authorization
string
header
required

Enter your JWT token in the format: Bearer

Body

Serializer for Group — a Keycloak group scoped to a department.

On write, supply department_id. On read, the full department object is returned. The keycloak_id field is read-only — set by the server at creation time and must never be changed by the client.

name
string
required

Name of the group, e.g. 'Commercial Operations'. Normalized to title case with single spaces on write.

Minimum string length: 1
department_id
string<uuid>
required
write-only

ID of the department this group belongs to.

description
string | null

Response

201 - application/json

Serializer for Group — a Keycloak group scoped to a department.

On write, supply department_id. On read, the full department object is returned. The keycloak_id field is read-only — set by the server at creation time and must never be changed by the client.

id
string<uuid>
required
read-only
name
string
required

Name of the group, e.g. 'Commercial Operations'. Normalized to title case with single spaces on write.

department
object
required

Serializer for Department.

keycloak_id
string | null
required
read-only
realm
string
default:capemedia
required
read-only

Keycloak realm this group belongs to

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string | null