Create a user group. POST /api/openapi/v1/user-groups, scope admin.v1.user-groups.manage.
- Scope: admin.v1.user-groups.manage
- Permission: Manage user groups (user-groups)
- Permission type: Manage
- Endpoint: POST/api/openapi/v1/user-groups
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Idempotency-Key | header | string | Required | Idempotency key used to prevent duplicate submissions | "<string>" |
| description | body | string | No | Description | "<string>" |
| members | body | array ｜ null | Required | Group members | [{"include_descendants":false,"subject_id":"<string>","subject_type":"user"}] |
| name | body | string | Required | User group name | "<string>" |
Request example
cURL
Responses
201 Created
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| created_at | string · date-time | Yes | Created at | "2026-08-27T10:00:00Z" |
| description | string | Yes | Description | "<string>" |
| id | string | Yes | User group ID | "<string>" |
| members | array ｜ null | Yes | Group members | [{"include_descendants":false,"subject_id":"<string>","subject_type":"user"}] |
| name | string | Yes | User group name | "<string>" |
| updated_at | string · date-time | Yes | Updated at | "2026-08-27T10:00:00Z" |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |