# \AdminApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**convert_user_to_group**](AdminApi.md#convert_user_to_group) | **POST** /w/{workspace}/users/convert_to_group/{username} | convert manual user to group user (require admin privilege)
[**delete_user**](AdminApi.md#delete_user) | **DELETE** /w/{workspace}/users/delete/{username} | delete user (require admin privilege)
[**get_user**](AdminApi.md#get_user) | **GET** /w/{workspace}/users/get/{username} | get user (require admin privilege)
[**offboard_preview**](AdminApi.md#offboard_preview) | **GET** /w/{workspace}/users/offboard_preview/{username} | preview offboarding for a workspace user (require admin privilege)
[**offboard_workspace_user**](AdminApi.md#offboard_workspace_user) | **POST** /w/{workspace}/users/offboard/{username} | offboard a workspace user (reassign objects, optionally delete user)
[**update_user**](AdminApi.md#update_user) | **POST** /w/{workspace}/users/update/{username} | update user (require admin privilege)



## convert_user_to_group

> String convert_user_to_group(workspace, username)
convert manual user to group user (require admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**username** | **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_user

> String delete_user(workspace, username)
delete user (require admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**username** | **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)


## get_user

> models::User get_user(workspace, username)
get user (require admin privilege)

### Parameters


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

### Return type

[**models::User**](User.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)


## offboard_preview

> models::OffboardPreview offboard_preview(workspace, username)
preview offboarding for a workspace user (require admin privilege)

### Parameters


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

### Return type

[**models::OffboardPreview**](OffboardPreview.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)


## offboard_workspace_user

> models::OffboardResponse offboard_workspace_user(workspace, username, offboard_request)
offboard a workspace user (reassign objects, optionally delete user)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**username** | **String** |  | [required] |
**offboard_request** | [**OffboardRequest**](OffboardRequest.md) |  | [required] |

### Return type

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

### Authorization

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

### 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

> String update_user(workspace, username, edit_workspace_user)
update user (require admin privilege)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**username** | **String** |  | [required] |
**edit_workspace_user** | [**EditWorkspaceUser**](EditWorkspaceUser.md) | new user | [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)

