outscale_api 1.14.0

Outscale API SDK
Documentation
# \UserGroupApi

All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_user_to_user_group**]UserGroupApi.md#add_user_to_user_group | **POST** /AddUserToUserGroup | 
[**create_user_group**]UserGroupApi.md#create_user_group | **POST** /CreateUserGroup | 
[**delete_user_group**]UserGroupApi.md#delete_user_group | **POST** /DeleteUserGroup | 
[**read_user_group**]UserGroupApi.md#read_user_group | **POST** /ReadUserGroup | 
[**read_user_groups**]UserGroupApi.md#read_user_groups | **POST** /ReadUserGroups | 
[**read_user_groups_per_user**]UserGroupApi.md#read_user_groups_per_user | **POST** /ReadUserGroupsPerUser | 
[**remove_user_from_user_group**]UserGroupApi.md#remove_user_from_user_group | **POST** /RemoveUserFromUserGroup | 
[**update_user_group**]UserGroupApi.md#update_user_group | **POST** /UpdateUserGroup | 



## add_user_to_user_group

> crate::models::AddUserToUserGroupResponse add_user_to_user_group(add_user_to_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**add_user_to_user_group_request** | Option<[**AddUserToUserGroupRequest**]AddUserToUserGroupRequest.md> |  |  |

### Return type

[**crate::models::AddUserToUserGroupResponse**](AddUserToUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## create_user_group

> crate::models::CreateUserGroupResponse create_user_group(create_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_user_group_request** | Option<[**CreateUserGroupRequest**]CreateUserGroupRequest.md> |  |  |

### Return type

[**crate::models::CreateUserGroupResponse**](CreateUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## delete_user_group

> crate::models::DeleteUserGroupResponse delete_user_group(delete_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**delete_user_group_request** | Option<[**DeleteUserGroupRequest**]DeleteUserGroupRequest.md> |  |  |

### Return type

[**crate::models::DeleteUserGroupResponse**](DeleteUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## read_user_group

> crate::models::ReadUserGroupResponse read_user_group(read_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_user_group_request** | Option<[**ReadUserGroupRequest**]ReadUserGroupRequest.md> |  |  |

### Return type

[**crate::models::ReadUserGroupResponse**](ReadUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## read_user_groups

> crate::models::ReadUserGroupsResponse read_user_groups(read_user_groups_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_user_groups_request** | Option<[**ReadUserGroupsRequest**]ReadUserGroupsRequest.md> |  |  |

### Return type

[**crate::models::ReadUserGroupsResponse**](ReadUserGroupsResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## read_user_groups_per_user

> crate::models::ReadUserGroupsPerUserResponse read_user_groups_per_user(read_user_groups_per_user_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_user_groups_per_user_request** | Option<[**ReadUserGroupsPerUserRequest**]ReadUserGroupsPerUserRequest.md> |  |  |

### Return type

[**crate::models::ReadUserGroupsPerUserResponse**](ReadUserGroupsPerUserResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## remove_user_from_user_group

> crate::models::RemoveUserFromUserGroupResponse remove_user_from_user_group(remove_user_from_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**remove_user_from_user_group_request** | Option<[**RemoveUserFromUserGroupRequest**]RemoveUserFromUserGroupRequest.md> |  |  |

### Return type

[**crate::models::RemoveUserFromUserGroupResponse**](RemoveUserFromUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)


## update_user_group

> crate::models::UpdateUserGroupResponse update_user_group(update_user_group_request)


### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_user_group_request** | Option<[**UpdateUserGroupRequest**]UpdateUserGroupRequest.md> |  |  |

### Return type

[**crate::models::UpdateUserGroupResponse**](UpdateUserGroupResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **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)