{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Group members
/api/usersandgroups/groups/{groupId}/members
Exposes one direct user-to-group membership as independently writable resource.
GET /api/usersandgroups/groups/{groupId}/members
Lists direct members of resolved parent group.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | string |
yes | group identifier from the URL |
fields |
query | string |
no | Comma-separated readable properties to include in the JSON response. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
array<GroupMemberRead> |
direct membership endpoints |
Example Request
# Request
GET /api/usersandgroups/groups/<groupId>/members HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
# Response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"membershipTypes": [
"string"
],
"userId": "13x1yz6efci6kxbgh0hpm4cpa"
}
]
POST /api/usersandgroups/groups/{groupId}/members
Creates staged membership below resolved parent group.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
groupId |
path | string |
yes | group identifier from the URL |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
GroupMemberCreate |
yes | — |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
201 |
application/json |
GroupMemberRead |
staged membership endpoint |
Example Request
# Request
POST /api/usersandgroups/groups/<groupId>/members HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json
{
"membershipTypes": [
"string"
],
"userId": "7h6uafbttt7rruhk7ro31w2rq"
}
# Response
HTTP/1.1 201 Created
Content-Type: application/json
{
"membershipTypes": [
"string"
],
"userId": "13x1yz6efci6kxbgh0hpm4cpa"
}
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.
GroupMemberRead
| Property | Type | Required | Description |
|---|---|---|---|
membershipTypes |
array<string> |
no |
Membership type keys assigned to member. |
userId |
string |
no |
Member identifier. Settable only while creating new membership. |
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |
GroupMemberCreate
| Property | Type | Required | Description |
|---|---|---|---|
membershipTypes |
array<string> |
no |
Replaces assigned membership type keys. |
userId |
string |
no |
Sets member ID on create; route identity remains immutable on updates. |