Groups
/api/usersandgroups/groups/{groupId}/type
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.
GET /api/usersandgroups/groups/{groupId}/type
Registered group type name. It is immutable after creation.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | string |
yes | group identifier from the URL |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request GET /api/usersandgroups/groups/<groupId>/type HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json "string"
PUT /api/usersandgroups/groups/{groupId}/type
Registered group type name. It is immutable after creation.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | string |
yes | group identifier from the URL |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
string |
yes |
Registered group type name. It is immutable after creation. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request PUT /api/usersandgroups/groups/<groupId>/type HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json "string" # Response HTTP/1.1 200 OK Content-Type: application/json "string"
Common Error Responses
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": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |