Interface IUsersService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface IUsersService : IApiAccessorMethods
DeleteUsersID(String, String)
Delete a user
Declaration
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
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
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 |
DeleteUsersIDWithHttpInfo(String, String)
Delete a user
Declaration
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 |
GetFlags(String)
Return the feature flags for the currently authenticated user
Declaration
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
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
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 |
GetFlagsWithHttpInfo(String)
Return the feature flags for the currently authenticated user
Declaration
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 |
GetMe(String)
Retrieve the currently authenticated user
Declaration
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
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
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 |
GetMeWithHttpInfo(String)
Retrieve the currently authenticated user
Declaration
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 |
GetUsers(String, Nullable<Int32>, Nullable<Int32>, String, String, String)
List all users
Declaration
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 |
| 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
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 |
| 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
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 |
| 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 |
GetUsersID(String, String)
Retrieve a user
Declaration
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
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
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 |
GetUsersIDWithHttpInfo(String, String)
Retrieve a user
Declaration
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 |
GetUsersWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String)
List all users
Declaration
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 |
| 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 |
PatchUsersID(String, PostUser, String)
Update a user
Declaration
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
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
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 |
PatchUsersIDWithHttpInfo(String, PostUser, String)
Update a user
Declaration
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 |
PostUsers(PostUser, String)
Create a user
Declaration
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
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
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 |
PostUsersIDPassword(String, PasswordResetBody, String, String)
Update a password
Declaration
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
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
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 |
PostUsersIDPasswordWithHttpInfo(String, PasswordResetBody, String, String)
Update a password
Declaration
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 |
PostUsersWithHttpInfo(PostUser, String)
Create a user
Declaration
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 |
PutMePassword(PasswordResetBody, String, String)
Update a password
Declaration
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
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
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 |
PutMePasswordWithHttpInfo(PasswordResetBody, String, String)
Update a password
Declaration
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 |