Create a Group

Error

A valid request URL is required to generate request examples

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "isTopGroup": false,
  "manager": "admin",
  "contactEmail": "admin@example.com",
  "isEnabled": true,
  "name": "My Group",
  "id": "my-group",
  "type": "custom",
  "parentId": "parent-group",
  "users": [
    "user1",
    "user2"
  ],
  "updatedAt": "2026-06-24T10:00:00.000Z"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

POST

groups

Error

A valid request URL is required to generate request examples

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "isTopGroup": false,
  "manager": "admin",
  "contactEmail": "admin@example.com",
  "isEnabled": true,
  "name": "My Group",
  "id": "my-group",
  "type": "custom",
  "parentId": "parent-group",
  "users": [
    "user1",
    "user2"
  ],
  "updatedAt": "2026-06-24T10:00:00.000Z"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

{
  "code": "<string>",
  "entityType": "<string>",
  "err": {},
  "message": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication. Send Authorization: Bearer .

Body

application/json

Group Input

GroupInput payload

displayName

string

required

Group's display name.

Example:

"Custom Group"

name

string

required

Group's unique identifier name.

Example:

"custom-group"

contactEmail

string

Group's contact email.

Example:

"team@example.com"

Response

Created

GroupFullResponse payload

contactEmail

string

Example:

"admin@example.com"

createdAt

string

Example:

"2026-01-01T00:00:00.000Z"

string

Example:

"my-group"

isEnabled

boolean

Example:

true

isTopGroup

boolean

Example:

false

manager

string

Example:

"admin"

name

string

Example:

"My Group"

parentId

string

Example:

"parent-group"

type

string

Example:

"custom"

updatedAt

string

Example:

"2026-06-24T10:00:00.000Z"

users

string[]

Example:

["user1", "user2"]

Overview

Authentication

Authorization

User information

Login MFA

Identity overview

Groups

Applications

Users

Account MFA

Identity providers

Application providers

Permissions

Roles

Security policies

Error handling

Create a Group

Authorizations

Body

Response