Download OpenAPI specification:
API documentation for managing user affiliations within groups and subgroups.
Returns list of affiliations for a user within the scope of a group. Returns affiliations to the parent group itself AND its subgroups. External group affiliations are excluded.
Required Permissions:
Note: This endpoint works for both top-level groups and subgroups (read-only access).
| group_id required | integer <int64> The ID of the parent group |
| user_id required | integer <int64> The ID of the user to get affiliations for |
[- {
- "groupId": 333,
- "groupName": "Parent Group",
- "expirationDate": null,
- "affiliated": true
}, - {
- "groupId": 100,
- "groupName": "subgroup-1",
- "expirationDate": null,
- "affiliated": true
}
]Add affiliations connecting a user to one or more subgroups. Only subgroups of the parent group are allowed.
Required Permissions (all required):
Important: This endpoint only works from a top-level group. Calling from a subgroup will return error: "Cannot directly update affiliations of a user in a subgroup"
| group_id required | integer <int64> The ID of the parent group (must be a top-level group) |
| user_id required | integer <int64> The ID of the user to add affiliations for |
The ID of a subgroup to affiliate the user with.
[- 100,
- 200,
- 300
]Expire affiliations for a user from one or more subgroups by setting the expiration date to the current date. Only subgroups of the parent group can be expired. This maintains the affiliation history while marking them as no longer active.
Required Permissions (all required):
Important: This endpoint only works from a top-level group.
| group_id required | integer <int64> The ID of the parent group (must be a top-level group) |
| user_id required | integer <int64> The ID of the user to expire affiliations for |
The ID of a subgroup whose affiliation should be expired.
[- 100,
- 200
]