# Auth groups

Generated reference for Auth groups endpoints.

This generated page groups every public API operation in the Auth groups category.

## Endpoints

- [GET /v1/public/accounts/{account_id}/auth/groups](/en/api/v1/public/accounts/account_id/auth/groups/get) - List Groups
- [GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/get) - List Group Members
- [POST /v1/public/accounts/{account_id}/auth/groups](/en/api/v1/public/accounts/account_id/auth/groups/post) - Create Group
- [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations](/en/api/v1/public/accounts/account_id/auth/groups/group_id/invitations/post) - Invite User To Group
- [GET /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/get) - Get Group
- [PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/patch) - Update Group
- [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/groups/post) - Add Group to Group
- [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/users/post) - Add User to Group
- [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/delete) - Delete Group
- [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/groups/child_group_id/delete) - Remove Group From Group
- [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/users/user_id/delete) - Remove User From Group

## List Groups

**GET** `/v1/public/accounts/{account_id}/auth/groups`

List Account Auth Groups

List groups bound to an account.

Full reference: [GET /v1/public/accounts/{account_id}/auth/groups](/en/api/v1/public/accounts/account_id/auth/groups/get)

OpenAPI reference: `/openapi.en.json GET /v1/public/accounts/{account_id}/auth/groups`

## List Group Members

**GET** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/members`

List Account Auth Group Members

List direct group members for a group bound to the path account.

Full reference: [GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/get)

OpenAPI reference: `/openapi.en.json GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members`

## Create Group

**POST** `/v1/public/accounts/{account_id}/auth/groups`

Create Account Auth Group

Create an account-bound group.

Full reference: [POST /v1/public/accounts/{account_id}/auth/groups](/en/api/v1/public/accounts/account_id/auth/groups/post)

OpenAPI reference: `/openapi.en.json POST /v1/public/accounts/{account_id}/auth/groups`

## Invite User To Group

**POST** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations`

Invite Account User To Group

Invite a user to a group bound to the path account.

Full reference: [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations](/en/api/v1/public/accounts/account_id/auth/groups/group_id/invitations/post)

OpenAPI reference: `/openapi.en.json POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations`

## Get Group

**GET** `/v1/public/accounts/{account_id}/auth/groups/{group_id}`

Get Account Auth Group

Return a group bound to the path account.

Full reference: [GET /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/get)

OpenAPI reference: `/openapi.en.json GET /v1/public/accounts/{account_id}/auth/groups/{group_id}`

## Update Group

**PATCH** `/v1/public/accounts/{account_id}/auth/groups/{group_id}`

Update Account Auth Group

Update a group bound to the path account.

Full reference: [PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/patch)

OpenAPI reference: `/openapi.en.json PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id}`

## Add Group to Group

**POST** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups`

Add Account Auth Group Group Member

Add a child group to a group bound to the path account.

Full reference: [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/groups/post)

OpenAPI reference: `/openapi.en.json POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups`

## Add User to Group

**POST** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users`

Add Account Auth Group User Member

Add a user to a group bound to the path account.

Full reference: [POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/users/post)

OpenAPI reference: `/openapi.en.json POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users`

## Delete Group

**DELETE** `/v1/public/accounts/{account_id}/auth/groups/{group_id}`

Delete Account Auth Group

Delete a group bound to the path account.

Full reference: [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/delete)

OpenAPI reference: `/openapi.en.json DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}`

## Remove Group From Group

**DELETE** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}`

Delete Account Auth Group Group Member

Remove a child group from a group bound to the path account.

Full reference: [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/groups/child_group_id/delete)

OpenAPI reference: `/openapi.en.json DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}`

## Remove User From Group

**DELETE** `/v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}`

Delete Account Auth Group User Member

Remove a user from a group bound to the path account.

Full reference: [DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}](/en/api/v1/public/accounts/account_id/auth/groups/group_id/members/users/user_id/delete)

OpenAPI reference: `/openapi.en.json DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}`