Class UsersService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

UsersService

Implements

IUsersService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class UsersService : object, IUsersService, IApiAccessor

Constructors

UsersService(Configuration)

Initializes a new instance of the UsersService class using Configuration object

Declaration

public UsersService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

UsersService(String)

Initializes a new instance of the UsersService class.

Declaration

public UsersService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

DeleteUsersID(String, String)

Delete a user

Declaration

public void DeleteUsersID(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDAsync(String, String, CancellationToken)

Delete a user

Declaration

public System.Threading.Tasks.Task DeleteUsersIDAsync(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteUsersIDAsyncWithHttpInfo(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteUsersIDAsyncWithIRestResponse(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDWithHttpInfo(String, String)

Delete a user

Declaration

public ApiResponse<object> DeleteUsersIDWithHttpInfo(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDWithIRestResponse(String, String)

Delete a user

Declaration

public RestResponse DeleteUsersIDWithIRestResponse(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteUsersIDWithIRestResponseAsync(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteUsersIDWithRestRequest(String, String)

Delete a user

Declaration

public RestRequest DeleteUsersIDWithRestRequest(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

GetFlags(String)

Return the feature flags for the currently authenticated user

Declaration

public Dictionary<string, object> GetFlags(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Dictionary<System.String, System.Object>	Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsAsync(String, CancellationToken)

Return the feature flags for the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<Dictionary<string, object>> GetFlagsAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Dictionary<System.String, System.Object>>	Task of Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsAsyncWithHttpInfo(String, CancellationToken)

Return the feature flags for the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Dictionary<string, object>>> GetFlagsAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Dictionary<System.String, System.Object>>>	Task of ApiResponse (Dictionary<string, Object>)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsAsyncWithIRestResponse(String, CancellationToken)

Return the feature flags for the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetFlagsAsyncWithIRestResponse(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Dictionary<string, Object>)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsWithHttpInfo(String)

Return the feature flags for the currently authenticated user

Declaration

public ApiResponse<Dictionary<string, object>> GetFlagsWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Dictionary<System.String, System.Object>>	ApiResponse of Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsWithIRestResponse(String)

Return the feature flags for the currently authenticated user

Declaration

public RestResponse GetFlagsWithIRestResponse(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsWithIRestResponseAsync(String, CancellationToken)

Return the feature flags for the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetFlagsWithIRestResponseAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetFlagsWithRestRequest(String)

Return the feature flags for the currently authenticated user

Declaration

public RestRequest GetFlagsWithRestRequest(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Dictionary<string, Object>

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMe(String)

Retrieve the currently authenticated user

Declaration

public User GetMe(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
User	User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeAsync(String, CancellationToken)

Retrieve the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<User> GetMeAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<User>	Task of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeAsyncWithHttpInfo(String, CancellationToken)

Retrieve the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<User>> GetMeAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<User>>	Task of ApiResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeAsyncWithIRestResponse(String, CancellationToken)

Retrieve the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetMeAsyncWithIRestResponse(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeWithHttpInfo(String)

Retrieve the currently authenticated user

Declaration

public ApiResponse<User> GetMeWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<User>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeWithIRestResponse(String)

Retrieve the currently authenticated user

Declaration

public RestResponse GetMeWithIRestResponse(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeWithIRestResponseAsync(String, CancellationToken)

Retrieve the currently authenticated user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetMeWithIRestResponseAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetMeWithRestRequest(String)

Retrieve the currently authenticated user

Declaration

public RestRequest GetMeWithRestRequest(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsers(String, Nullable<Int32>, Nullable<Int32>, String, String, String)

List all users

Declaration

public Users GetUsers(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)

Returns

Type	Description
Users	Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersAsync(String, Nullable<Int32>, Nullable<Int32>, String, String, String, CancellationToken)

List all users

Declaration

public async System.Threading.Tasks.Task<Users> GetUsersAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Users>	Task of Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String, CancellationToken)

List all users

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Users>> GetUsersAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Users>>	Task of ApiResponse (Users)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersAsyncWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, String, String, String, CancellationToken)

List all users

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetUsersAsyncWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Users)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersID(String, String)

Retrieve a user

Declaration

public User GetUsersID(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
User	User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDAsync(String, String, CancellationToken)

Retrieve a user

Declaration

public async System.Threading.Tasks.Task<User> GetUsersIDAsync(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<User>	Task of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<User>> GetUsersIDAsyncWithHttpInfo(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<User>>	Task of ApiResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetUsersIDAsyncWithIRestResponse(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDWithHttpInfo(String, String)

Retrieve a user

Declaration

public ApiResponse<User> GetUsersIDWithHttpInfo(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<User>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDWithIRestResponse(String, String)

Retrieve a user

Declaration

public RestResponse GetUsersIDWithIRestResponse(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetUsersIDWithIRestResponseAsync(string userID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersIDWithRestRequest(String, String)

Retrieve a user

Declaration

public RestRequest GetUsersIDWithRestRequest(string userID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String)

List all users

Declaration

public ApiResponse<Users> GetUsersWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Users>	ApiResponse of Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, String, String, String)

List all users

Declaration

public RestResponse GetUsersWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)

Returns

Type	Description
RestResponse	ApiResponse of Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersWithIRestResponseAsync(String, Nullable<Int32>, Nullable<Int32>, String, String, String, CancellationToken)

List all users

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetUsersWithIRestResponseAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetUsersWithRestRequest(String, Nullable<Int32>, Nullable<Int32>, String, String, String)

List all users

Declaration

public RestRequest GetUsersWithRestRequest(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	name	(optional)
System.String	id	(optional)

Returns

Type	Description
RestRequest	ApiResponse of Users

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersID(String, PostUser, String)

Update a user

Declaration

public User PatchUsersID(string userID, PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
User	User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDAsync(String, PostUser, String, CancellationToken)

Update a user

Declaration

public async System.Threading.Tasks.Task<User> PatchUsersIDAsync(string userID, PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<User>	Task of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDAsyncWithHttpInfo(String, PostUser, String, CancellationToken)

Update a user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<User>> PatchUsersIDAsyncWithHttpInfo(string userID, PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<User>>	Task of ApiResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDAsyncWithIRestResponse(String, PostUser, String, CancellationToken)

Update a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchUsersIDAsyncWithIRestResponse(string userID, PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDWithHttpInfo(String, PostUser, String)

Update a user

Declaration

public ApiResponse<User> PatchUsersIDWithHttpInfo(string userID, PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<User>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDWithIRestResponse(String, PostUser, String)

Update a user

Declaration

public RestResponse PatchUsersIDWithIRestResponse(string userID, PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDWithIRestResponseAsync(String, PostUser, String, CancellationToken)

Update a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchUsersIDWithIRestResponseAsync(string userID, PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchUsersIDWithRestRequest(String, PostUser, String)

Update a user

Declaration

public RestRequest PatchUsersIDWithRestRequest(string userID, PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the user to update.
PostUser	postUser	User update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsers(PostUser, String)

Create a user

Declaration

public User PostUsers(PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
User	User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersAsync(PostUser, String, CancellationToken)

Create a user

Declaration

public async System.Threading.Tasks.Task<User> PostUsersAsync(PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<User>	Task of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersAsyncWithHttpInfo(PostUser, String, CancellationToken)

Create a user

Declaration

public async System.Threading.Tasks.Task<ApiResponse<User>> PostUsersAsyncWithHttpInfo(PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<User>>	Task of ApiResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersAsyncWithIRestResponse(PostUser, String, CancellationToken)

Create a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostUsersAsyncWithIRestResponse(PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (User)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPassword(String, PasswordResetBody, String, String)

Update a password

Declaration

public void PostUsersIDPassword(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordAsync(String, PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public System.Threading.Tasks.Task PostUsersIDPasswordAsync(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordAsyncWithHttpInfo(String, PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> PostUsersIDPasswordAsyncWithHttpInfo(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordAsyncWithIRestResponse(String, PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostUsersIDPasswordAsyncWithIRestResponse(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordWithHttpInfo(String, PasswordResetBody, String, String)

Update a password

Declaration

public ApiResponse<object> PostUsersIDPasswordWithHttpInfo(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordWithIRestResponse(String, PasswordResetBody, String, String)

Update a password

Declaration

public RestResponse PostUsersIDPasswordWithIRestResponse(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordWithIRestResponseAsync(String, PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostUsersIDPasswordWithIRestResponseAsync(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersIDPasswordWithRestRequest(String, PasswordResetBody, String, String)

Update a password

Declaration

public RestRequest PostUsersIDPasswordWithRestRequest(string userID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
System.String	userID	The user ID.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersWithHttpInfo(PostUser, String)

Create a user

Declaration

public ApiResponse<User> PostUsersWithHttpInfo(PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<User>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersWithIRestResponse(PostUser, String)

Create a user

Declaration

public RestResponse PostUsersWithIRestResponse(PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersWithIRestResponseAsync(PostUser, String, CancellationToken)

Create a user

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostUsersWithIRestResponseAsync(PostUser postUser, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostUsersWithRestRequest(PostUser, String)

Create a user

Declaration

public RestRequest PostUsersWithRestRequest(PostUser postUser, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostUser	postUser	User to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of User

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePassword(PasswordResetBody, String, String)

Update a password

Declaration

public void PutMePassword(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordAsync(PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public System.Threading.Tasks.Task PutMePasswordAsync(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordAsyncWithHttpInfo(PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> PutMePasswordAsyncWithHttpInfo(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordAsyncWithIRestResponse(PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutMePasswordAsyncWithIRestResponse(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordWithHttpInfo(PasswordResetBody, String, String)

Update a password

Declaration

public ApiResponse<object> PutMePasswordWithHttpInfo(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordWithIRestResponse(PasswordResetBody, String, String)

Update a password

Declaration

public RestResponse PutMePasswordWithIRestResponse(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordWithIRestResponseAsync(PasswordResetBody, String, String, CancellationToken)

Update a password

Declaration

public async System.Threading.Tasks.Task<RestResponse> PutMePasswordWithIRestResponseAsync(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PutMePasswordWithRestRequest(PasswordResetBody, String, String)

Update a password

Declaration

public RestRequest PutMePasswordWithRestRequest(PasswordResetBody passwordResetBody, string zapTraceSpan = null, string authorization = null)

Parameters

Type	Name	Description
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	authorization	An auth credential for the Basic scheme (optional)

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IUsersService