windmill-api 1.684.0

# \UserApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**accept_invite**](UserApi.md#accept_invite) | **POST** /users/accept_invite | accept invite to workspace
[**convert_user_to_group**](UserApi.md#convert_user_to_group) | **POST** /w/{workspace}/users/convert_to_group/{username} | convert manual user to group user (require admin privilege)
[**create_token**](UserApi.md#create_token) | **POST** /users/tokens/create | create token
[**create_token_impersonate**](UserApi.md#create_token_impersonate) | **POST** /users/tokens/impersonate | create token to impersonate a user (require superadmin)
[**create_user_globally**](UserApi.md#create_user_globally) | **POST** /users/create | create user
[**decline_invite**](UserApi.md#decline_invite) | **POST** /users/decline_invite | decline invite to workspace
[**delete_token**](UserApi.md#delete_token) | **DELETE** /users/tokens/delete/{token_prefix} | delete token
[**delete_user**](UserApi.md#delete_user) | **DELETE** /w/{workspace}/users/delete/{username} | delete user (require admin privilege)
[**exists_email**](UserApi.md#exists_email) | **GET** /users/exists/{email} | exists email
[**exit_impersonation**](UserApi.md#exit_impersonation) | **POST** /w/{workspace}/users/exit_impersonation | exit service account impersonation
[**get_current_email**](UserApi.md#get_current_email) | **GET** /users/email | get current user email (if logged in)
[**get_runnable**](UserApi.md#get_runnable) | **GET** /users/all_runnables | get all runnables in every workspace
[**get_tutorial_progress**](UserApi.md#get_tutorial_progress) | **GET** /users/tutorial_progress | get tutorial progress
[**get_usage**](UserApi.md#get_usage) | **GET** /users/usage | get current usage outside of premium workspaces
[**get_user**](UserApi.md#get_user) | **GET** /w/{workspace}/users/get/{username} | get user (require admin privilege)
[**global_offboard_preview**](UserApi.md#global_offboard_preview) | **GET** /users/offboard_preview/{email} | preview global offboarding for a user across all workspaces (require super admin)
[**global_user_delete**](UserApi.md#global_user_delete) | **DELETE** /users/delete/{email} | global delete user (require super admin)
[**global_user_rename**](UserApi.md#global_user_rename) | **POST** /users/rename/{email} | global rename user (require super admin)
[**global_user_update**](UserApi.md#global_user_update) | **POST** /users/update/{email} | global update user (require super admin)
[**global_username_info**](UserApi.md#global_username_info) | **GET** /users/username_info/{email} | global username info (require super admin)
[**global_users_export**](UserApi.md#global_users_export) | **GET** /users/export | global export users (require super admin and EE)
[**global_users_overwrite**](UserApi.md#global_users_overwrite) | **POST** /users/overwrite | global overwrite users (require super admin and EE)
[**global_whoami**](UserApi.md#global_whoami) | **GET** /users/whoami | get current global whoami (if logged in)
[**impersonate_service_account**](UserApi.md#impersonate_service_account) | **POST** /w/{workspace}/users/impersonate_service_account | impersonate a service account
[**is_owner_of_path**](UserApi.md#is_owner_of_path) | **GET** /w/{workspace}/users/is_owner/{path} | is owner of path
[**is_smtp_configured**](UserApi.md#is_smtp_configured) | **GET** /auth/is_smtp_configured | check if SMTP is configured for password reset
[**leave_instance**](UserApi.md#leave_instance) | **POST** /users/leave_instance | leave instance
[**list_ext_jwt_tokens**](UserApi.md#list_ext_jwt_tokens) | **GET** /users/ext_jwt_tokens | list external JWT tokens (ee only)
[**list_tokens**](UserApi.md#list_tokens) | **GET** /users/tokens/list | list token
[**list_usernames**](UserApi.md#list_usernames) | **GET** /w/{workspace}/users/list_usernames | list usernames
[**list_users**](UserApi.md#list_users) | **GET** /w/{workspace}/users/list | list users
[**list_users_as_super_admin**](UserApi.md#list_users_as_super_admin) | **GET** /users/list_as_super_admin | list all users as super admin (require to be super amdin)
[**list_users_usage**](UserApi.md#list_users_usage) | **GET** /w/{workspace}/users/list_usage | list users usage
[**list_workspace_invites**](UserApi.md#list_workspace_invites) | **GET** /users/list_invites | list all workspace invites
[**login**](UserApi.md#login) | **POST** /auth/login | login with password
[**login_with_oauth**](UserApi.md#login_with_oauth) | **POST** /oauth/login_callback/{client_name} | login with oauth authorization flow
[**logout**](UserApi.md#logout) | **POST** /auth/logout | logout
[**offboard_global_user**](UserApi.md#offboard_global_user) | **POST** /users/offboard/{email} | offboard a user globally (reassign objects across workspaces, optionally delete)
[**offboard_preview**](UserApi.md#offboard_preview) | **GET** /w/{workspace}/users/offboard_preview/{username} | preview offboarding for a workspace user (require admin privilege)
[**offboard_workspace_user**](UserApi.md#offboard_workspace_user) | **POST** /w/{workspace}/users/offboard/{username} | offboard a workspace user (reassign objects, optionally delete user)
[**refresh_user_token**](UserApi.md#refresh_user_token) | **GET** /users/refresh_token | refresh the current token
[**request_password_reset**](UserApi.md#request_password_reset) | **POST** /auth/request_password_reset | request password reset email
[**reset_password**](UserApi.md#reset_password) | **POST** /auth/reset_password | reset password using token
[**set_login_type_for_user**](UserApi.md#set_login_type_for_user) | **POST** /users/set_login_type/{user} | set login type for a specific user (require super admin)
[**set_password**](UserApi.md#set_password) | **POST** /users/setpassword | set password
[**set_password_for_user**](UserApi.md#set_password_for_user) | **POST** /users/set_password_of/{user} | set password for a specific user (require super admin)
[**submit_onboarding_data**](UserApi.md#submit_onboarding_data) | **POST** /users/onboarding | Submit user onboarding data
[**update_tutorial_progress**](UserApi.md#update_tutorial_progress) | **POST** /users/tutorial_progress | update tutorial progress
[**update_user**](UserApi.md#update_user) | **POST** /w/{workspace}/users/update/{username} | update user (require admin privilege)
[**username_to_email**](UserApi.md#username_to_email) | **GET** /w/{workspace}/users/username_to_email/{username} | get email from username
[**whoami**](UserApi.md#whoami) | **GET** /w/{workspace}/users/whoami | whoami
[**whois**](UserApi.md#whois) | **GET** /w/{workspace}/users/whois/{username} | whois



## accept_invite

> String accept_invite(accept_invite_request)
accept invite to workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_invite_request** | [**AcceptInviteRequest**](AcceptInviteRequest.md) | accept invite | [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)


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


## create_token

> String create_token(new_token)
create token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_token** | [**NewToken**](NewToken.md) | new token | [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_token_impersonate

> String create_token_impersonate(new_token_impersonate)
create token to impersonate a user (require superadmin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_token_impersonate** | [**NewTokenImpersonate**](NewTokenImpersonate.md) | new token | [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_user_globally

> String create_user_globally(create_user_globally_request)
create user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_user_globally_request** | [**CreateUserGloballyRequest**](CreateUserGloballyRequest.md) | user info | [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)


## decline_invite

> String decline_invite(decline_invite_request)
decline invite to workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**decline_invite_request** | [**DeclineInviteRequest**](DeclineInviteRequest.md) | decline invite | [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_token

> String delete_token(token_prefix)
delete token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**token_prefix** | **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)


## exists_email

> bool exists_email(email)
exists email

### Parameters


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

### Return type

**bool**

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


## exit_impersonation

> String exit_impersonation(workspace, get_github_app_token200_response)
exit service account impersonation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**get_github_app_token200_response** | [**GetGithubAppToken200Response**](GetGithubAppToken200Response.md) |  | [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)


## get_current_email

> String get_current_email()
get current user email (if logged in)

### Parameters

This endpoint does not need any parameter.

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

> models::GetRunnable200Response get_runnable()
get all runnables in every workspace

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetRunnable200Response**](getRunnable_200_response.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_tutorial_progress

> models::GetTutorialProgress200Response get_tutorial_progress()
get tutorial progress

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetTutorialProgress200Response**](getTutorialProgress_200_response.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_usage

> f64 get_usage()
get current usage outside of premium workspaces

### Parameters

This endpoint does not need any parameter.

### Return type

**f64**

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


## global_offboard_preview

> models::GlobalOffboardPreview global_offboard_preview(email)
preview global offboarding for a user across all workspaces (require super admin)

### Parameters


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

### Return type

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


## global_user_delete

> String global_user_delete(email)
global delete user (require super admin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**email** | **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)


## global_user_rename

> String global_user_rename(email, global_user_rename_request)
global rename user (require super admin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**email** | **String** |  | [required] |
**global_user_rename_request** | [**GlobalUserRenameRequest**](GlobalUserRenameRequest.md) | new username | [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)


## global_user_update

> String global_user_update(email, global_user_update_request)
global update user (require super admin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**email** | **String** |  | [required] |
**global_user_update_request** | [**GlobalUserUpdateRequest**](GlobalUserUpdateRequest.md) | new user info | [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)


## global_username_info

> models::GlobalUsernameInfo200Response global_username_info(email)
global username info (require super admin)

### Parameters


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

### Return type

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


## global_users_export

> Vec<models::ExportedUser> global_users_export()
global export users (require super admin and EE)

### Parameters

This endpoint does not need any parameter.

### Return type

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


## global_users_overwrite

> String global_users_overwrite(exported_user)
global overwrite users (require super admin and EE)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**exported_user** | [**Vec<models::ExportedUser>**](ExportedUser.md) | List of users | [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)


## global_whoami

> models::GlobalUserInfo global_whoami()
get current global whoami (if logged in)

### Parameters

This endpoint does not need any parameter.

### Return type

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


## impersonate_service_account

> String impersonate_service_account(workspace, create_service_account_request)
impersonate a service account

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_service_account_request** | [**CreateServiceAccountRequest**](CreateServiceAccountRequest.md) |  | [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)


## is_owner_of_path

> bool is_owner_of_path(workspace, path)
is owner of path

### Parameters


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

### Return type

**bool**

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


## is_smtp_configured

> bool is_smtp_configured()
check if SMTP is configured for password reset

### Parameters

This endpoint does not need any parameter.

### Return type

**bool**

### Authorization

No authorization required

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


## leave_instance

> String leave_instance()
leave instance

### Parameters

This endpoint does not need any parameter.

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


## list_ext_jwt_tokens

> Vec<models::ExternalJwtToken> list_ext_jwt_tokens(page, per_page, active_only)
list external JWT tokens (ee only)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> |  |  |
**per_page** | Option<**i32**> |  |  |
**active_only** | Option<**bool**> | only tokens used in the last 30 days |  |

### Return type

[**Vec<models::ExternalJwtToken>**](ExternalJwtToken.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_tokens

> Vec<models::TruncatedToken> list_tokens(exclude_ephemeral, page, per_page)
list token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**exclude_ephemeral** | Option<**bool**> |  |  |
**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::TruncatedToken>**](TruncatedToken.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_usernames

> Vec<String> list_usernames(workspace)
list usernames

### Parameters


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

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

> Vec<models::User> list_users(workspace)
list users

### Parameters


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

### Return type

[**Vec<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)


## list_users_as_super_admin

> Vec<models::GlobalUserInfo> list_users_as_super_admin(page, per_page, active_only)
list all users as super admin (require to be super amdin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**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) |  |
**active_only** | Option<**bool**> | filter only active users |  |

### Return type

[**Vec<models::GlobalUserInfo>**](GlobalUserInfo.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_users_usage

> Vec<models::UserUsage> list_users_usage(workspace)
list users usage

### Parameters


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

### Return type

[**Vec<models::UserUsage>**](UserUsage.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_workspace_invites

> Vec<models::WorkspaceInvite> list_workspace_invites()
list all workspace invites

### Parameters

This endpoint does not need any parameter.

### Return type

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


## login

> String login(login)
login with password

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**login** | [**Login**](Login.md) | credentials | [required] |

### Return type

**String**

### Authorization

No authorization required

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


## login_with_oauth

> String login_with_oauth(client_name, login_with_oauth_request)
login with oauth authorization flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**client_name** | **String** |  | [required] |
**login_with_oauth_request** | [**LoginWithOauthRequest**](LoginWithOauthRequest.md) | Partially filled script | [required] |

### Return type

**String**

### Authorization

No authorization required

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


## logout

> String logout()
logout

### Parameters

This endpoint does not need any parameter.

### Return type

**String**

### Authorization

No authorization required

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


## offboard_global_user

> models::OffboardResponse offboard_global_user(email, global_offboard_request)
offboard a user globally (reassign objects across workspaces, optionally delete)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**email** | **String** |  | [required] |
**global_offboard_request** | [**GlobalOffboardRequest**](GlobalOffboardRequest.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)


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


## refresh_user_token

> String refresh_user_token(if_expiring_in_less_than_s)
refresh the current token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**if_expiring_in_less_than_s** | Option<**i32**> |  |  |

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


## request_password_reset

> models::PasswordResetResponse request_password_reset(request_password_reset_request)
request password reset email

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**request_password_reset_request** | [**RequestPasswordResetRequest**](RequestPasswordResetRequest.md) | email to send password reset link to | [required] |

### Return type

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

### Authorization

No authorization required

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


## reset_password

> models::PasswordResetResponse reset_password(reset_password_request)
reset password using token

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**reset_password_request** | [**ResetPasswordRequest**](ResetPasswordRequest.md) | token and new password | [required] |

### Return type

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

### Authorization

No authorization required

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


## set_login_type_for_user

> String set_login_type_for_user(user, set_login_type_for_user_request)
set login type for a specific user (require super admin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user** | **String** |  | [required] |
**set_login_type_for_user_request** | [**SetLoginTypeForUserRequest**](SetLoginTypeForUserRequest.md) | set login type | [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)


## set_password

> String set_password(set_password_request)
set password

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**set_password_request** | [**SetPasswordRequest**](SetPasswordRequest.md) | set password | [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)


## set_password_for_user

> String set_password_for_user(user, set_password_request)
set password for a specific user (require super admin)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user** | **String** |  | [required] |
**set_password_request** | [**SetPasswordRequest**](SetPasswordRequest.md) | set password | [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)


## submit_onboarding_data

> String submit_onboarding_data(submit_onboarding_data_request)
Submit user onboarding data

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**submit_onboarding_data_request** | [**SubmitOnboardingDataRequest**](SubmitOnboardingDataRequest.md) |  | [required] |

### Return type

**String**

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

> String update_tutorial_progress(get_tutorial_progress200_response)
update tutorial progress

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**get_tutorial_progress200_response** | [**GetTutorialProgress200Response**](GetTutorialProgress200Response.md) | progress update | [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_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)


## username_to_email

> String username_to_email(workspace, username)
get email from username

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


## whoami

> models::User whoami(workspace)
whoami

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **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)


## whois

> models::User whois(workspace, username)
whois

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