# User groups

## Get all groups

 - [GET /resources/groups/v1](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_getallgroups.md): Retrieve all user groups for an account (tenant).

## Create group

 - [POST /resources/groups/v1](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_creategroup.md): Create a user group for an account (tenant).

Provide the group details in the request body.

## Get groups by Ids

 - [POST /resources/groups/v1/bulkGet](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_getgroupsbyids.md): Retrieve user groups by given IDs for an account (tenant).

Provide the group IDs in the request body.

## Update group

 - [PATCH /resources/groups/v1/{id}](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_updategroup.md): Update a user group by ID for an account (tenant).

Provide the group ID as a path parameter and the updated group details in the request body.

## Delete group

 - [DELETE /resources/groups/v1/{id}](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_deletegroup.md): Delete a user group by ID for an account (tenant).

Provide the group ID as a path parameter.

## Get group by ID

 - [GET /resources/groups/v1/{id}](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_getgroupbyid.md): Retrieve a user group by ID for an account (tenant).

Provide the group ID as a path parameter.

## Get groups configuration

 - [GET /resources/groups/v1/config](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_getgroupsconfiguration.md): Retrieve the user group configuration for your environment.

## Create or update groups configuration

 - [POST /resources/groups/v1/config](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_createorupdategroupsconfiguration.md): Create or update the user group configuration for your environment.

Provide the configuration details in the request body.

## Add roles to group

 - [POST /resources/groups/v1/{groupId}/roles](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_addrolestogroup.md): Add roles to an existing user group.

A user can assign only roles that are lower than their own.

## Remove roles from group

 - [DELETE /resources/groups/v1/{groupId}/roles](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_removerolesfromgroup.md): Remove roles from an existing user group.

Provide the roles to remove in the request body.

## Add users to group

 - [POST /resources/groups/v1/{groupId}/users](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_adduserstogroup.md): Add users to an existing user group.

Only users with higher roles than the group's roles are allowed to perform this action.

## Remove users from group

 - [DELETE /resources/groups/v1/{groupId}/users](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv1_removeusersfromgroup.md): Remove users from an existing user group.

Provide the users to remove in the request body.

## Get all groups paginated

 - [GET /resources/groups/v2](https://developers.frontegg.com/ciam/api/identity/user-groups/groupscontrollerv2_getallgroupspaginated.md): Retrieve all user groups for an account (tenant), with pagination.

Use query parameters to control pagination and optionally include related group data.