# \GroupApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_user_to_group**](GroupApi.md#add_user_to_group) | **POST** /w/{workspace}/groups/adduser/{name} | add user to group
[**add_user_to_instance_group**](GroupApi.md#add_user_to_instance_group) | **POST** /groups/adduser/{name} | add user to instance group
[**create_group**](GroupApi.md#create_group) | **POST** /w/{workspace}/groups/create | create group
[**create_instance_group**](GroupApi.md#create_instance_group) | **POST** /groups/create | create instance group
[**delete_group**](GroupApi.md#delete_group) | **DELETE** /w/{workspace}/groups/delete/{name} | delete group
[**delete_instance_group**](GroupApi.md#delete_instance_group) | **DELETE** /groups/delete/{name} | delete instance group
[**export_instance_groups**](GroupApi.md#export_instance_groups) | **GET** /groups/export | export instance groups
[**get_group**](GroupApi.md#get_group) | **GET** /w/{workspace}/groups/get/{name} | get group
[**get_group_permission_history**](GroupApi.md#get_group_permission_history) | **GET** /w/{workspace}/groups_history/get/{name} | get group permission history
[**get_instance_group**](GroupApi.md#get_instance_group) | **GET** /groups/get/{name} | get instance group
[**list_group_names**](GroupApi.md#list_group_names) | **GET** /w/{workspace}/groups/listnames | list group names
[**list_groups**](GroupApi.md#list_groups) | **GET** /w/{workspace}/groups/list | list groups
[**list_instance_groups**](GroupApi.md#list_instance_groups) | **GET** /groups/list | list instance groups
[**list_instance_groups_with_workspaces**](GroupApi.md#list_instance_groups_with_workspaces) | **GET** /groups/list_with_workspaces | list instance groups with workspace information
[**overwrite_instance_groups**](GroupApi.md#overwrite_instance_groups) | **POST** /groups/overwrite | overwrite instance groups
[**remove_user_from_instance_group**](GroupApi.md#remove_user_from_instance_group) | **POST** /groups/removeuser/{name} | remove user from instance group
[**remove_user_to_group**](GroupApi.md#remove_user_to_group) | **POST** /w/{workspace}/groups/removeuser/{name} | remove user to group
[**update_group**](GroupApi.md#update_group) | **POST** /w/{workspace}/groups/update/{name} | update group
[**update_instance_group**](GroupApi.md#update_instance_group) | **POST** /groups/update/{name} | update instance group



## add_user_to_group

> String add_user_to_group(workspace, name, add_user_to_group_request)
add user to group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**add_user_to_group_request** | [**AddUserToGroupRequest**](AddUserToGroupRequest.md) | added user to group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## add_user_to_instance_group

> String add_user_to_instance_group(name, add_user_to_instance_group_request)
add user to instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** |  | [required] |
**add_user_to_instance_group_request** | [**AddUserToInstanceGroupRequest**](AddUserToInstanceGroupRequest.md) | user to add to instance group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_group

> String create_group(workspace, create_instance_group_request)
create group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_instance_group_request** | [**CreateInstanceGroupRequest**](CreateInstanceGroupRequest.md) | create group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_instance_group

> String create_instance_group(create_instance_group_request)
create instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_instance_group_request** | [**CreateInstanceGroupRequest**](CreateInstanceGroupRequest.md) | create instance group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_group

> String delete_group(workspace, name)
delete group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_instance_group

> String delete_instance_group(name)
delete instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_instance_groups

> Vec<models::ExportedInstanceGroup> export_instance_groups()
export instance groups

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ExportedInstanceGroup>**](ExportedInstanceGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_group

> models::Group get_group(workspace, name)
get group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |

### Return type

[**models::Group**](Group.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_group_permission_history

> Vec<models::GetGroupPermissionHistory200ResponseInner> get_group_permission_history(workspace, name, page, per_page)
get group permission history

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::GetGroupPermissionHistory200ResponseInner>**](getGroupPermissionHistory_200_response_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_instance_group

> models::InstanceGroupWithWorkspaces get_instance_group(name)
get instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** |  | [required] |

### Return type

[**models::InstanceGroupWithWorkspaces**](InstanceGroupWithWorkspaces.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_group_names

> Vec<String> list_group_names(workspace, only_member_of)
list group names

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**only_member_of** | Option<**bool**> | only list the groups the user is member of (default false) |  |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_groups

> Vec<models::Group> list_groups(workspace, page, per_page)
list groups

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::Group>**](Group.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_instance_groups

> Vec<models::InstanceGroup> list_instance_groups()
list instance groups

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::InstanceGroup>**](InstanceGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_instance_groups_with_workspaces

> Vec<models::InstanceGroupWithWorkspaces> list_instance_groups_with_workspaces()
list instance groups with workspace information

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::InstanceGroupWithWorkspaces>**](InstanceGroupWithWorkspaces.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## overwrite_instance_groups

> String overwrite_instance_groups(exported_instance_group)
overwrite instance groups

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**exported_instance_group** | [**Vec<models::ExportedInstanceGroup>**](ExportedInstanceGroup.md) | overwrite instance groups | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_user_from_instance_group

> String remove_user_from_instance_group(name, add_user_to_instance_group_request)
remove user from instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** |  | [required] |
**add_user_to_instance_group_request** | [**AddUserToInstanceGroupRequest**](AddUserToInstanceGroupRequest.md) | user to remove from instance group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_user_to_group

> String remove_user_to_group(workspace, name, add_user_to_group_request)
remove user to group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**add_user_to_group_request** | [**AddUserToGroupRequest**](AddUserToGroupRequest.md) | added user to group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_group

> String update_group(workspace, name, update_group_request)
update group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [required] |
**update_group_request** | [**UpdateGroupRequest**](UpdateGroupRequest.md) | updated group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_instance_group

> String update_instance_group(name, update_instance_group_request)
update instance group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**name** | **String** |  | [required] |
**update_instance_group_request** | [**UpdateInstanceGroupRequest**](UpdateInstanceGroupRequest.md) | update instance group | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

