🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/groups/index.md.
A FusionAuth Group is a named object that optionally contains one to many Application Roles.
When a Group does not contain any Application Roles it can still be utilized to logically associate users. Assigning Application Roles to a group allow it to be used to dynamically manage Role assignment to registered Users. In this second scenario as long as a User is registered to an Application the Group membership will allow them to inherit the corresponding Roles from the Group.
The following APIs are provided to manage Groups and Group Membership.
| Operation | Method | Endpoint |
|---|---|---|
| Create a Group | POST | /api/group/api/group/{groupId} |
| Retrieve a Group | GET | /api/group/api/group/{groupId} |
| Update a Group | PUT | /api/group/{groupId} |
| Delete a Group | DELETE | /api/group/{groupId} |
| Search for Groups | GETPOST | /api/group/search?name={name}&tenantId={tenantId}/api/group/search |
| Add Users to a Group | POST | /api/group/member |
| Update Users in a Group | PUT | /api/group/member |
| Remove Users from a Group | DELETE | /api/group/member/{memberId}/api/group/member?groupId={groupId}&userId={userId}/api/group/member?groupId={groupId}/api/group/member |
| Search for Group Members | GETPOST | /api/group/member/search?groupId={groupId}/api/group/member/search |