/api/usersandgroups/groups

Exposes groups through the annotation-based WebAPI.

The collection operation deliberately returns compact summaries. A model operation returns only fields whose registered GroupFieldDefinition grants access to the current caller. All mutations are staged on this request-local object and are validated before the first manager write.

For an existing group, both PUT and PATCH use partial-update semantics: only properties supplied by the request are changed, while omitted properties retain their current values. PUT is not a full replacement.

Lists active groups using the existing Users and Groups search syntax.

# Request
GET /api/usersandgroups/groups HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "displayName": "string",
        "name": "string",
        "active": true,
        "id": "9ueizsfbz96hjr85vbjk5qflt",
        "type": "string"
    }
]

Creates a request-local group. The request body supplies at least a name and a registered type before commit.

# Request
POST /api/usersandgroups/groups HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "fields": {
        "property": {
            
        }
    },
    "permissions": [
        "string"
    ],
    "parentId": "b4pqq67l5tc1ytk3iee51pyir",
    "name": "string",
    "type": "string"
}

# Response
HTTP/1.1 201 Created
Content-Type: application/json

{
    "fields": {
        "property": {
            
        }
    },
    "permissions": [
        "string"
    ],
    "parentId": "b2pyti3zkr818upt7qui2t8ov",
    "id": "c6ld2ivtvzlj3b4w3kd7hskch",
    "name": "string"
}

The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:

{
    "status": 404,
    "code": "route_not_found",
    "message": "The requested API route does not exist.",
    "details": []
}

Request and response schemas used on this page.

Type: object