# Groups API

Provides access to the groups that are part of a Hyperproof organization.

Version: 1.0

## Servers

Hyperproof US
```
https://api.hyperproof.app/v1/groups
```

Hyperproof Gov
```
https://api.hyperproofgov.app/v1/groups
```

Hyperproof EU
```
https://api.hyperproof.eu/v1/groups
```

## Security

### oauth2

Type: oauth2

## Download OpenAPI description

[Groups API](https://developer.hyperproof.app/_bundle/hyperproof-api/groups/groups.openapi.yaml)

## Other

### Add Group

 - [POST /](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/add-group.md): POST /

#### Description

Creates a new group in Hyperproof, defining its name, description, and initial membership or permissions.

### Get Groups

 - [GET /](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/get-groups.md): GET /

#### Description

Retrieves details of all groups within an organiztion, including their names, descriptions, and membership information.

### Get Group

 - [GET /{groupId}](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/get-group.md): GET /{groupId}

#### Description

Retrieves details of a specific group by its unique ID, including its name, description, and membership information.

### Update Group

 - [PATCH /{groupId}](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/update-group.md): PATCH /{groupId}

#### Description

Updates the details of an existing group, allowing changes to its name, description, or membership configuration.

### Get All Group Members

 - [GET /users](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/get-all-group-members.md): GET /users}

#### Description

Retrieves the members of groups in the organization.

#### Notes and caveats

### Get Group Members

 - [GET /{groupId}/users](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/get-group-members.md): GET /{groupId}

#### Description

Retrieves the members of a group.

### Add Group Member

 - [POST /{groupId}/users](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/add-group-member.md): POST /{groupId}/users

#### Description

Adds a user to a specified group, granting them the roles and permissions associated with that group.

### Remove Group Members

 - [PUT /{groupId}/users/delete](https://developer.hyperproof.app/hyperproof-api/groups/groups.openapi/other/remove-group-member.md): PUT /{groupId}/users/delete

#### Description

Removes one or more members from a specified group, updating the group’s membership and associated permissions.