ptctools 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ptctools/portainer_client/openapi_client/docs/UsersApi.md

@@ -0,0 +1,1159 @@
+# openapi_client.UsersApi
+
+All URIs are relative to */api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**current_user_inspect**](UsersApi.md#current_user_inspect) | **GET** /users/me | Inspect the current user user
+[**user_admin_check**](UsersApi.md#user_admin_check) | **GET** /users/admin/check | Check administrator account existence
+[**user_admin_init**](UsersApi.md#user_admin_init) | **POST** /users/admin/init | Initialize administrator account
+[**user_create**](UsersApi.md#user_create) | **POST** /users | Create a new user
+[**user_delete**](UsersApi.md#user_delete) | **DELETE** /users/{id} | Remove a user
+[**user_generate_api_key**](UsersApi.md#user_generate_api_key) | **POST** /users/{id}/tokens | Generate an API key for a user
+[**user_get_api_keys**](UsersApi.md#user_get_api_keys) | **GET** /users/{id}/tokens | Get all API keys for a user
+[**user_inspect**](UsersApi.md#user_inspect) | **GET** /users/{id} | Inspect a user
+[**user_list**](UsersApi.md#user_list) | **GET** /users | List users
+[**user_memberships_inspect**](UsersApi.md#user_memberships_inspect) | **GET** /users/{id}/memberships | Inspect a user memberships
+[**user_remove_api_key**](UsersApi.md#user_remove_api_key) | **DELETE** /users/{id}/tokens/{keyID} | Remove an api-key associated to a user
+[**user_update**](UsersApi.md#user_update) | **PUT** /users/{id} | Update a user
+[**user_update_password**](UsersApi.md#user_update_password) | **PUT** /users/{id}/passwd | Update password for a user
+
+
+# **current_user_inspect**
+> PortainerUser current_user_inspect()
+
+Inspect the current user user
+
+Retrieve details about the current  user.
+User passwords are filtered out, and should never be accessible.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+
+    try:
+        # Inspect the current user user
+        api_response = api_instance.current_user_inspect()
+        print("The response of UsersApi->current_user_inspect:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->current_user_inspect: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PortainerUser**](PortainerUser.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_admin_check**
+> user_admin_check()
+
+Check administrator account existence
+
+Check if an administrator account exists in the database.
+**Access policy**: public
+
+### Example
+
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+
+    try:
+        # Check administrator account existence
+        api_instance.user_admin_check()
+    except Exception as e:
+        print("Exception when calling UsersApi->user_admin_check: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Success |  -  |
+**404** | User not found |  -  |
+
+[[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)
+
+# **user_admin_init**
+> PortainerUser user_admin_init(body)
+
+Initialize administrator account
+
+Initialize the 'admin' user account.
+**Access policy**: public
+
+### Example
+
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.models.users_admin_init_payload import UsersAdminInitPayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    body = openapi_client.UsersAdminInitPayload() # UsersAdminInitPayload | User details
+
+    try:
+        # Initialize administrator account
+        api_response = api_instance.user_admin_init(body)
+        print("The response of UsersApi->user_admin_init:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_admin_init: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UsersAdminInitPayload**](UsersAdminInitPayload.md)| User details | 
+
+### Return type
+
+[**PortainerUser**](PortainerUser.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**409** | Admin user already initialized |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_create**
+> PortainerUser user_create(body)
+
+Create a new user
+
+Create a new Portainer user.
+Only administrators can create users.
+**Access policy**: restricted
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.models.users_user_create_payload import UsersUserCreatePayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    body = openapi_client.UsersUserCreatePayload() # UsersUserCreatePayload | User details
+
+    try:
+        # Create a new user
+        api_response = api_instance.user_create(body)
+        print("The response of UsersApi->user_create:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_create: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UsersUserCreatePayload**](UsersUserCreatePayload.md)| User details | 
+
+### Return type
+
+[**PortainerUser**](PortainerUser.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**409** | User already exists |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_delete**
+> user_delete(id)
+
+Remove a user
+
+Remove a user.
+**Access policy**: administrator
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+
+    try:
+        # Remove a user
+        api_instance.user_delete(id)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_delete: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_generate_api_key**
+> UsersAccessTokenResponse user_generate_api_key(id, body)
+
+Generate an API key for a user
+
+Generates an API key for a user.
+Only the calling user can generate a token for themselves.
+Password is required only for internal authentication.
+**Access policy**: restricted
+
+### Example
+
+* Api Key Authentication (jwt):
+
+```python
+import openapi_client
+from openapi_client.models.users_access_token_response import UsersAccessTokenResponse
+from openapi_client.models.users_user_access_token_create_payload import UsersUserAccessTokenCreatePayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+    body = openapi_client.UsersUserAccessTokenCreatePayload() # UsersUserAccessTokenCreatePayload | details
+
+    try:
+        # Generate an API key for a user
+        api_response = api_instance.user_generate_api_key(id, body)
+        print("The response of UsersApi->user_generate_api_key:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_generate_api_key: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+ **body** | [**UsersUserAccessTokenCreatePayload**](UsersUserAccessTokenCreatePayload.md)| details | 
+
+### Return type
+
+[**UsersAccessTokenResponse**](UsersAccessTokenResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**401** | Unauthorized |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_get_api_keys**
+> List[PortainerAPIKey] user_get_api_keys(id)
+
+Get all API keys for a user
+
+Gets all API keys for a user.
+Only the calling user or admin can retrieve api-keys.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_api_key import PortainerAPIKey
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+
+    try:
+        # Get all API keys for a user
+        api_response = api_instance.user_get_api_keys(id)
+        print("The response of UsersApi->user_get_api_keys:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_get_api_keys: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+
+### Return type
+
+[**List[PortainerAPIKey]**](PortainerAPIKey.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_inspect**
+> PortainerUser user_inspect(id)
+
+Inspect a user
+
+Retrieve details about a user.
+User passwords are filtered out, and should never be accessible.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+
+    try:
+        # Inspect a user
+        api_response = api_instance.user_inspect(id)
+        print("The response of UsersApi->user_inspect:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_inspect: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+
+### Return type
+
+[**PortainerUser**](PortainerUser.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_list**
+> List[PortainerUser] user_list(environment_id=environment_id)
+
+List users
+
+List Portainer users.
+Non-administrator users will only be able to list other non-administrator user accounts.
+User passwords are filtered out, and should never be accessible.
+**Access policy**: restricted
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    environment_id = 56 # int | Identifier of the environment(endpoint) that will be used to filter the authorized users (optional)
+
+    try:
+        # List users
+        api_response = api_instance.user_list(environment_id=environment_id)
+        print("The response of UsersApi->user_list:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_list: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **environment_id** | **int**| Identifier of the environment(endpoint) that will be used to filter the authorized users | [optional] 
+
+### Return type
+
+[**List[PortainerUser]**](PortainerUser.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_memberships_inspect**
+> List[PortainerTeamMembership] user_memberships_inspect(id)
+
+Inspect a user memberships
+
+Inspect a user memberships.
+**Access policy**: restricted
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_team_membership import PortainerTeamMembership
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+
+    try:
+        # Inspect a user memberships
+        api_response = api_instance.user_memberships_inspect(id)
+        print("The response of UsersApi->user_memberships_inspect:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_memberships_inspect: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+
+### Return type
+
+[**List[PortainerTeamMembership]**](PortainerTeamMembership.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_remove_api_key**
+> user_remove_api_key(id, key_id)
+
+Remove an api-key associated to a user
+
+Remove an api-key associated to a user..
+Only the calling user or admin can remove api-key.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+    key_id = 56 # int | Api Key identifier
+
+    try:
+        # Remove an api-key associated to a user
+        api_instance.user_remove_api_key(id, key_id)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_remove_api_key: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+ **key_id** | **int**| Api Key identifier | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | Not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_update**
+> PortainerUser user_update(id, body)
+
+Update a user
+
+Update user details. A regular user account can only update his details.
+A regular user account cannot change their username or role.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.portainer_user import PortainerUser
+from openapi_client.models.users_user_update_payload import UsersUserUpdatePayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | User identifier
+    body = openapi_client.UsersUserUpdatePayload() # UsersUserUpdatePayload | User details
+
+    try:
+        # Update a user
+        api_response = api_instance.user_update(id, body)
+        print("The response of UsersApi->user_update:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_update: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| User identifier | 
+ **body** | [**UsersUserUpdatePayload**](UsersUserUpdatePayload.md)| User details | 
+
+### Return type
+
+[**PortainerUser**](PortainerUser.md)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**409** | Username already exist |  -  |
+**500** | Server error |  -  |
+
+[[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)
+
+# **user_update_password**
+> user_update_password(id, body)
+
+Update password for a user
+
+Update password for the specified user.
+**Access policy**: authenticated
+
+### Example
+
+* Api Key Authentication (jwt):
+* Api Key Authentication (ApiKeyAuth):
+
+```python
+import openapi_client
+from openapi_client.models.users_user_update_password_payload import UsersUserUpdatePasswordPayload
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = openapi_client.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: jwt
+configuration.api_key['jwt'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['jwt'] = 'Bearer'
+
+# Configure API key authorization: ApiKeyAuth
+configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.UsersApi(api_client)
+    id = 56 # int | identifier
+    body = openapi_client.UsersUserUpdatePasswordPayload() # UsersUserUpdatePasswordPayload | details
+
+    try:
+        # Update password for a user
+        api_instance.user_update_password(id, body)
+    except Exception as e:
+        print("Exception when calling UsersApi->user_update_password: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| identifier | 
+ **body** | [**UsersUserUpdatePasswordPayload**](UsersUserUpdatePasswordPayload.md)| details | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Success |  -  |
+**400** | Invalid request |  -  |
+**403** | Permission denied |  -  |
+**404** | User not found |  -  |
+**500** | Server error |  -  |
+
+[[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)
+