🔐 Sid Gifari File Manager Pro
v8.0.5 | 2026-08-08 12:45:26 | PHP 8.2.32
📂
/ (Root)
/
opt
/
alt
/
python38
/
lib
/
python3.8
/
site-packages
/
influxdb_client
/
service
/
__pycache__
📍 /opt/alt/python38/lib/python3.8/site-packages/influxdb_client/service/__pycache__
🔄 Refresh
✏️
Editing: users_service.cpython-38.pyc
Read Only
U w�i� � @ s8 d Z ddlmZ ddlZddlmZ G dd� de�ZdS )a InfluxDB OSS API Service. The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. # noqa: E501 OpenAPI spec version: 2.0.0 Generated by: https://openapi-generator.tech � )�absolute_importN)� _BaseServicec sB e Zd ZdZdM� fdd� Zdd� Zdd� Zd d � Zd d � Zd d� Z dd� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Zd3d4� Z d5d6� Z d7d8� Z d9d:� Z d;d<� Z d=d>� Z!d?d@� Z"dAdB� Z#dCdD� Z$dEdF� Z%dGdH� Z&dIdJ� Z'dKdL� Z(� Z)S )N� UsersServicez�NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. Nc s t � �|� dS )z.UsersService - a operation defined in OpenAPI.N)�super�__init__)�self� api_client�� __class__� �V/opt/alt/python38/lib/python3.8/site-packages/influxdb_client/service/users_service.pyr s zUsersService.__init__c K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a7 Delete a user. Deletes a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Delete a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to delete. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_users_id(user_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. T�_return_http_data_only� async_reqN)�get� delete_users_id_with_http_info�r �user_id�kwargs�datar r r �delete_users_id s z UsersService.delete_users_idc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) aF Delete a user. Deletes a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Delete a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to delete. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_users_id_with_http_info(user_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. �/api/v2/users/{userID}�DELETENr r �_preload_contentT�_request_timeout� urlopen_kw� �bodyZ post_params�filesZ response_typeZ auth_settingsr r r r Zcollection_formatsr ��_delete_users_id_preparer �call_apir �r r r �local_var_params� path_params� query_params� header_params� body_paramsr r r r 7 s( � �z+UsersService.delete_users_id_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a� Delete a user. Deletes a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Delete a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to delete. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. r r Nr r r Tr r r r r! r r r �delete_users_id_async[ s( � �z"UsersService.delete_users_id_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr �zap_trace_spanr zGMissing the required parameter `user_id` when calling `delete_users_id`�userID�Zap-Trace-Span�application/json�Accept��locals�_check_operation_params� ValueErrorr �select_header_accept� r r r r" � all_paramsr# r$ r% r& r r r r | s& � �z%UsersService._delete_users_id_preparec K s2 d|d< |� d�r | jf |�S | jf |�}|S dS )a� Retrieve the currently authenticated user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_me(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. Tr r N)r �get_me_with_http_info�r r r r r r �get_me� s zUsersService.get_mec K sd | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� Retrieve the currently authenticated user. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_me_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. � /api/v2/me�GET� UserResponser r r Tr r Nr ��_get_me_preparer r r �r r r" r# r$ r% r& r r r r4 � s( � �z"UsersService.get_me_with_http_infoc � sj | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) aK Retrieve the currently authenticated user. This method makes an asynchronous HTTP request. :param async_req bool :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. r7 r8 r9 r r r Tr r Nr r: r< r r r � get_me_async� s( � �zUsersService.get_me_asyncc K s^ t � }dg}| �d||� i }g }i }d|kr:|d |d< d }| j�dg�|d< |||||fS )Nr( r6 r* r+ r, )r. r/ r r1 �r r r" r3 r# r$ r% r& r r r r; � s �z UsersService._get_me_preparec K s2 d|d< |� d�r | jf |�S | jf |�}|S dS )a List users. Lists [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). Default limit is `20`. To limit which users are returned, pass query parameters in your request. #### Required permissions for InfluxDB OSS | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | List all users | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | | List a specific user | `read-users` or `read-user USER_ID` | | *`USER_ID`* is the ID of the user that you want to retrieve. #### Related guides - [View users](https://docs.influxdata.com/influxdb/latest/users/view-users/). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_users(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str name: A user name. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :param str id: A user ID. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :return: Users If the method is called asynchronously, returns the request thread. Tr r N)r �get_users_with_http_infor5 r r r � get_users s zUsersService.get_usersc K sd | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a List users. Lists [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). Default limit is `20`. To limit which users are returned, pass query parameters in your request. #### Required permissions for InfluxDB OSS | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | List all users | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | | List a specific user | `read-users` or `read-user USER_ID` | | *`USER_ID`* is the ID of the user that you want to retrieve. #### Related guides - [View users](https://docs.influxdata.com/influxdb/latest/users/view-users/). This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_users_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str name: A user name. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :param str id: A user ID. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :return: Users If the method is called asynchronously, returns the request thread. � /api/v2/usersr8 �Usersr r r Tr r Nr ��_get_users_preparer r r r< r r r r? s( � �z%UsersService.get_users_with_http_infoc � sj | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) aY List users. Lists [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). Default limit is `20`. To limit which users are returned, pass query parameters in your request. #### Required permissions for InfluxDB OSS | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | List all users | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | | List a specific user | `read-users` or `read-user USER_ID` | | *`USER_ID`* is the ID of the user that you want to retrieve. #### Related guides - [View users](https://docs.influxdata.com/influxdb/latest/users/view-users/). This method makes an asynchronous HTTP request. :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str name: A user name. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :param str id: A user ID. Only lists the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). :return: Users If the method is called asynchronously, returns the request thread. rA r8 rB r r r Tr r Nr rC r< r r r �get_users_asyncE s( � �z UsersService.get_users_asyncc K sB t � }ddddddg}| �d||� d|kr@|d dk r@td ��d|kr\|d d kr\td ��d|krx|d d k rxtd ��i }g }d|kr�|�d|d f� d|kr�|�d|d f� d|kr�|�d|d f� d|kr�|�d|d f� d|k�r|�d|d f� i }d|k�r |d |d< d }| j�dg�|d< |||||fS )Nr( �offset�limit�after�name�idr@ r zkInvalid value for parameter `offset` when calling `get_users`, must be a value greater than or equal to `0`�d ziInvalid value for parameter `limit` when calling `get_users`, must be a value less than or equal to `100`� zjInvalid value for parameter `limit` when calling `get_users`, must be a value greater than or equal to `1`r* r+ r, )r. r/ r0 �appendr r1 r> r r r rD j s: �z UsersService._get_users_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )aG Retrieve a user. Retrieves a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_users_id(user_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Retrieves the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. Tr r N)r �get_users_id_with_http_infor r r r � get_users_id� s zUsersService.get_users_idc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) aV Retrieve a user. Retrieves a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_users_id_with_http_info(user_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Retrieves the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. r r8 r9 r r r Tr r Nr ��_get_users_id_preparer r r r! r r r rN � s( � �z(UsersService.get_users_id_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Retrieve a user. Retrieves a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: A user ID. Retrieves the specified [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. r r8 r9 r r r Tr r Nr rP r! r r r �get_users_id_async� s( � �z UsersService.get_users_id_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr r( rO zDMissing the required parameter `user_id` when calling `get_users_id`r) r* r+ r, r- r2 r r r rQ � s& � �z"UsersService._get_users_id_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a� Update a user. Updates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) and returns the user. #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Update a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to update. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.patch_users_id(user_id, user, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to update. (required) :param User user: In the request body, provide the user properties to update. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. Tr r N)r � patch_users_id_with_http_info)r r �userr r r r r �patch_users_id s zUsersService.patch_users_idc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� Update a user. Updates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) and returns the user. #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Update a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to update. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.patch_users_id_with_http_info(user_id, user, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to update. (required) :param User user: In the request body, provide the user properties to update. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. r �PATCHr9 r r r Tr r Nr ��_patch_users_id_preparer r r � r r rT r r" r# r$ r% r& r r r rS s( � �z*UsersService.patch_users_id_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Update a user. Updates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) and returns the user. #### Required permissions | Action | Permission required | |:------------|:-----------------------------------------------| | Update a user | `write-users` or `write-user USER_ID` | *`USER_ID`* is the ID of the user that you want to update. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/organizations/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: A user ID. Specifies the [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) to update. (required) :param User user: In the request body, provide the user properties to update. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. r rV r9 r r r Tr r Nr rW rY r r r �patch_users_id_asyncC s( � �z!UsersService.patch_users_id_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr rT r( rU zFMissing the required parameter `user_id` when calling `patch_users_id`zCMissing the required parameter `user` when calling `patch_users_id`r) r* r+ r, � Content-Type�r. r/ r0 r r1 Zselect_header_content_type) r r rT r r" r3 r# r$ r% r& r r r rX e s8 � � ��z$UsersService._patch_users_id_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a Create a user. Creates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session through one of the following interfaces: - InfluxDB UI - `/api/v2/signin` InfluxDB API endpoint - InfluxDB CLI This endpoint represents the first two steps in a four-step process to allow a user to authenticate with a username and password, and then access data in an organization: 1. Create a user: send a `POST` request to `POST /api/v2/users`. The `name` property is required. 2. Extract the user ID (`id` property) value from the API response for _step 1_. 3. Create an authorization (and API token) for the user: send a `POST` request to [`POST /api/v2/authorizations`](#operation/PostAuthorizations), passing the user ID (`id`) from _step 2_. 4. Create a password for the user: send a `POST` request to [`POST /api/v2/users/USER_ID/password`](#operation/PostUsersIDPassword), passing the user ID from _step 2_. #### Required permissions | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | Create a user | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | #### Related guides - [Create a user](https://docs.influxdata.com/influxdb/latest/users/create-user/) - [Create an API token scoped to a user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_users(user, async_req=True) >>> result = thread.get() :param async_req bool :param User user: The user to create. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. Tr r N)r �post_users_with_http_info)r rT r r r r r � post_users� s zUsersService.post_usersc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a, Create a user. Creates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session through one of the following interfaces: - InfluxDB UI - `/api/v2/signin` InfluxDB API endpoint - InfluxDB CLI This endpoint represents the first two steps in a four-step process to allow a user to authenticate with a username and password, and then access data in an organization: 1. Create a user: send a `POST` request to `POST /api/v2/users`. The `name` property is required. 2. Extract the user ID (`id` property) value from the API response for _step 1_. 3. Create an authorization (and API token) for the user: send a `POST` request to [`POST /api/v2/authorizations`](#operation/PostAuthorizations), passing the user ID (`id`) from _step 2_. 4. Create a password for the user: send a `POST` request to [`POST /api/v2/users/USER_ID/password`](#operation/PostUsersIDPassword), passing the user ID from _step 2_. #### Required permissions | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | Create a user | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | #### Related guides - [Create a user](https://docs.influxdata.com/influxdb/latest/users/create-user/) - [Create an API token scoped to a user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_users_with_http_info(user, async_req=True) >>> result = thread.get() :param async_req bool :param User user: The user to create. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. rA �POSTr9 r r r Tr r Nr ��_post_users_preparer r r �r rT r r" r# r$ r% r& r r r r] � s( � �z&UsersService.post_users_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) ao Create a user. Creates a [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session through one of the following interfaces: - InfluxDB UI - `/api/v2/signin` InfluxDB API endpoint - InfluxDB CLI This endpoint represents the first two steps in a four-step process to allow a user to authenticate with a username and password, and then access data in an organization: 1. Create a user: send a `POST` request to `POST /api/v2/users`. The `name` property is required. 2. Extract the user ID (`id` property) value from the API response for _step 1_. 3. Create an authorization (and API token) for the user: send a `POST` request to [`POST /api/v2/authorizations`](#operation/PostAuthorizations), passing the user ID (`id`) from _step 2_. 4. Create a password for the user: send a `POST` request to [`POST /api/v2/users/USER_ID/password`](#operation/PostUsersIDPassword), passing the user ID from _step 2_. #### Required permissions | Action | Permission required | Restriction | |:-------|:--------------------|:------------| | Create a user | _[Operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ | | #### Related guides - [Create a user](https://docs.influxdata.com/influxdb/latest/users/create-user/) - [Create an API token scoped to a user](https://docs.influxdata.com/influxdb/latest/security/tokens/create-token/#create-a-token-scoped-to-a-user) This method makes an asynchronous HTTP request. :param async_req bool :param User user: The user to create. (required) :param str zap_trace_span: OpenTracing span context :return: UserResponse If the method is called asynchronously, returns the request thread. rA r_ r9 r r r Tr r Nr r` rb r r r �post_users_async� s( � �z UsersService.post_users_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }g }i }d|krX|d |d< d }d|krl|d }| j�dg�|d< | j�dg�|d< |||||fS ) NrT r( r^ z?Missing the required parameter `user` when calling `post_users`r* r+ r, r[ r\ ) r rT r r" r3 r# r$ r% r& r r r ra � s, � ��z UsersService._post_users_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )ak Update a password. Updates a user password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_users_id_password(user_id, password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. Tr r N)r �%post_users_id_password_with_http_info�r r �password_reset_bodyr r r r r �post_users_id_password s z#UsersService.post_users_id_passwordc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) az Update a password. Updates a user password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_users_id_password_with_http_info(user_id, password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. � /api/v2/users/{userID}/passwordr_ Nr r r Tr r r �� _post_users_id_password_preparer r r � r r rf r r" r# r$ r% r& r r r rd s( � �z2UsersService.post_users_id_password_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a� Update a password. Updates a user password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. rh r_ Nr r r Tr r r ri rk r r r � post_users_id_password_asyncB s( � �z)UsersService.post_users_id_password_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr rf r( rg zNMissing the required parameter `user_id` when calling `post_users_id_password`zZMissing the required parameter `password_reset_body` when calling `post_users_id_password`r) r* r+ r, r[ r\ � r r rf r r" r3 r# r$ r% r& r r r rj d s8 � � ��z,UsersService._post_users_id_password_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� Update a password. Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: 1. Pass the user's [Basic authentication credentials](#section/Authentication/BasicAuthentication) to the `POST /api/v2/signin` endpoint to create a user session and generate a session cookie. 2. From the response in the first step, extract the session cookie (`Set-Cookie`) header. 3. Pass the following in a request to the `PUT /api/v2/me/password` endpoint: - The `Set-Cookie` header from the second step - The `Authorization Basic` header with the user's _Basic authentication_ credentials - `{"password": "NEW_PASSWORD"}` in the request body #### InfluxDB Cloud - Doesn't let you manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update your password. #### Related endpoints - [Signin](#tag/Signin) - [Signout](#tag/Signout) - [Users](#tag/Users) #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_me_password(password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param PasswordResetBody password_reset_body: The new password. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. Tr r N)r � put_me_password_with_http_info)r rf r r r r r �put_me_password� s z UsersService.put_me_passwordc K sh | j |f|�\}}}}}| jjdd||||g i ddg|�d�|�d�|�dd�|�d �i |�d d�d �S ) a� Update a password. Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: 1. Pass the user's [Basic authentication credentials](#section/Authentication/BasicAuthentication) to the `POST /api/v2/signin` endpoint to create a user session and generate a session cookie. 2. From the response in the first step, extract the session cookie (`Set-Cookie`) header. 3. Pass the following in a request to the `PUT /api/v2/me/password` endpoint: - The `Set-Cookie` header from the second step - The `Authorization Basic` header with the user's _Basic authentication_ credentials - `{"password": "NEW_PASSWORD"}` in the request body #### InfluxDB Cloud - Doesn't let you manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update your password. #### Related endpoints - [Signin](#tag/Signin) - [Signout](#tag/Signout) - [Users](#tag/Users) #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_me_password_with_http_info(password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param PasswordResetBody password_reset_body: The new password. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. �/api/v2/me/password�PUTN�BasicAuthenticationr r r Tr r r ��_put_me_password_preparer r r �r rf r r" r# r$ r% r& r r r rn � s( � �z+UsersService.put_me_password_with_http_infoc � sn | j |f|�\}}}}}| jjdd||||g i ddg|�d�|�d�|�dd�|�d �i |�d d�d �I dH S ) a� Update a password. Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user). This endpoint represents the third step in the following three-step process to let a user with a user session update their password: 1. Pass the user's [Basic authentication credentials](#section/Authentication/BasicAuthentication) to the `POST /api/v2/signin` endpoint to create a user session and generate a session cookie. 2. From the response in the first step, extract the session cookie (`Set-Cookie`) header. 3. Pass the following in a request to the `PUT /api/v2/me/password` endpoint: - The `Set-Cookie` header from the second step - The `Authorization Basic` header with the user's _Basic authentication_ credentials - `{"password": "NEW_PASSWORD"}` in the request body #### InfluxDB Cloud - Doesn't let you manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update your password. #### Related endpoints - [Signin](#tag/Signin) - [Signout](#tag/Signout) - [Users](#tag/Users) #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes an asynchronous HTTP request. :param async_req bool :param PasswordResetBody password_reset_body: The new password. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. rp rq Nrr r r r Tr r r rs ru r r r �put_me_password_async� s( � �z"UsersService.put_me_password_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��i }g }i }d|krZ|d |d< d|krn|d |d< d }d|kr�|d }| j�dg�|d < | j�dg�|d < |||||fS ) Nrf r( � authorizationro zSMissing the required parameter `password_reset_body` when calling `put_me_password`r* � Authorizationr+ r, r[ r\ ) r rf r r" r3 r# r$ r% r& r r r rt � s0 � ��z%UsersService._put_me_password_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )aO Update a password. Updates a user password. Use this endpoint to let a user authenticate with [Basic authentication credentials](#section/Authentication/BasicAuthentication) and set a new password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_users_id_password(user_id, password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. Tr r N)r �$put_users_id_password_with_http_infore r r r �put_users_id_password s z"UsersService.put_users_id_passwordc K sj | j ||f|�\}}}}}| jjdd||||g i ddg|�d�|�d�|�dd�|�d �i |�d d�d �S ) a^ Update a password. Updates a user password. Use this endpoint to let a user authenticate with [Basic authentication credentials](#section/Authentication/BasicAuthentication) and set a new password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.put_users_id_password_with_http_info(user_id, password_reset_body, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. rh rq Nrr r r r Tr r r �� _put_users_id_password_preparer r r rk r r r ry " s( � �z1UsersService.put_users_id_password_with_http_infoc � sp | j ||f|�\}}}}}| jjdd||||g i ddg|�d�|�d�|�dd�|�d �i |�d d�d �I dH S ) a~ Update a password. Updates a user password. Use this endpoint to let a user authenticate with [Basic authentication credentials](#section/Authentication/BasicAuthentication) and set a new password. #### InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password. #### Related guides - [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/) - [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: The ID of the user to set the password for. (required) :param PasswordResetBody password_reset_body: The new password to set for the user. (required) :param str zap_trace_span: OpenTracing span context :param str authorization: An auth credential for the Basic scheme :return: None If the method is called asynchronously, returns the request thread. rh rq Nrr r r r Tr r r r{ rk r r r �put_users_id_password_asyncH s( � �z(UsersService.put_users_id_password_asyncc K s� t � }ddddg}| �d||� d|ks4|d d kr<td��d|ksP|d d krXtd��i }d|krp|d |d< g }i }d|kr�|d |d < d|kr�|d |d < d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS )Nr rf r( rw rz zMMissing the required parameter `user_id` when calling `put_users_id_password`zYMissing the required parameter `password_reset_body` when calling `put_users_id_password`r) r* rx r+ r, r[ r\ rm r r r r| k s< � � ��z+UsersService._put_users_id_password_prepare)N)*�__name__� __module__� __qualname__�__doc__r r r r' r r6 r4 r= r; r@ r? rE rD rO rN rR rQ rU rS rZ rX r^ r] rc ra rg rd rl rj ro rn rv rt rz ry r} r| � __classcell__r r r r r sL $!" (%%$!%"%$! %"%%"!&#r )r� � __future__r �reZ%influxdb_client.service._base_servicer r r r r r �<module> s
💾 Save Changes
❌ Cancel