# Groups

Manage user groups


## Servers

Sandbox environment
```
https://api.sbx.transmitsecurity.io/cis
```

Production environment (US)
```
https://api.transmitsecurity.io/cis
```

Production environment (EU)
```
https://api.eu.transmitsecurity.io/cis
```

Production environment (CA)
```
https://api.ca.transmitsecurity.io/cis
```

Production environment (AU)
```
https://api.au.transmitsecurity.io/cis
```

## Security

### bearer

Type: http
Scheme: bearer
Bearer Format: JWT

### UserAccessToken

A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated

Type: http
Scheme: bearer
Bearer Format: JWT

### AdminAccessToken

A token generated by a management application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to all resources for the tenant and its apps

Type: oauth2

### ClientAccessToken

A token generated by an end-user application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)

Type: oauth2

### OrgAdminAccessToken

A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Type: oauth2

## Download OpenAPI description

[Groups](https://developer.transmitsecurity.com/_bundle/openapi/user/groups.openapi.yaml)

## Other

### Create group

 - [POST /v1/groups](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/creategroup.md): Create a group for your users. Required permissions: apps:create, [appId]:create, groups:create.

### Get groups

 - [GET /v1/groups](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/getallgroups.md): Retrieve a list of all groups. Required permissions: apps:read, [appId]:read, groups:read, apps:list, [appId]:list, groups:list.

### Get group by ID

 - [GET /v1/groups/{group_id}](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/getgroupbyid.md): Retrieve a group by ID. Required permissions: apps:read, [appId]:read, groups:read.

### Update group

 - [PUT /v1/groups/{group_id}](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/updategroup.md): Update a group for your users. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. Required permissions: apps:edit, [appId]:edit, groups:edit.

### Delete group

 - [DELETE /v1/groups/{group_id}](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/deletegroup.md): Delete a group. Required permissions: apps:delete, [appId]:delete, groups:delete.

### Add users to group

 - [POST /v1/groups/{group_id}/members](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/assignusers.md): Add one or more users as members of a group. Required permissions: apps:edit, [appId]:edit, groups:edit.

### Get group's users

 - [GET /v1/groups/{group_id}/members](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/getgroupusers.md): Retrieve all users that are members of a specific group. Required permissions: apps:read, [appId]:read, users:read.

### Remove user from group

 - [DELETE /v1/groups/{group_id}/members/{user_id}](https://developer.transmitsecurity.com/openapi/user/groups.openapi/other/removeassignment.md): Remove a user from a group. Required permissions: apps:edit, [appId]:edit, groups:edit.