Class AuthorizationsService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class AuthorizationsService : object, IAuthorizationsService, IApiAccessor
Constructors
AuthorizationsService(Configuration)
Initializes a new instance of the AuthorizationsService class using Configuration object
Declaration
public AuthorizationsService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
AuthorizationsService(String)
Initializes a new instance of the AuthorizationsService class.
Declaration
public AuthorizationsService(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 |
DeleteAuthorizationsID(String, String)
Delete an authorization
Declaration
public void DeleteAuthorizationsID(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to delete. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteAuthorizationsIDAsync(String, String, CancellationToken)
Delete an authorization
Declaration
public System.Threading.Tasks.Task DeleteAuthorizationsIDAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete an authorization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteAuthorizationsIDAsyncWithHttpInfo(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteAuthorizationsIDAsyncWithIRestResponse(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDWithHttpInfo(String, String)
Delete an authorization
Declaration
public ApiResponse<object> DeleteAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDWithIRestResponse(String, String)
Delete an authorization
Declaration
public RestResponse DeleteAuthorizationsIDWithIRestResponse(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDWithIRestResponseAsync(String, String, CancellationToken)
Delete an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteAuthorizationsIDWithIRestResponseAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
DeleteAuthorizationsIDWithRestRequest(String, String)
Delete an authorization
Declaration
public RestRequest DeleteAuthorizationsIDWithRestRequest(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization 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 |
GetAuthorizations(String, String, String, String, String)
List all authorizations
Declaration
public Authorizations GetAuthorizations(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
Returns
Type | Description |
---|---|
Authorizations | Authorizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsAsync(String, String, String, String, String, CancellationToken)
List all authorizations
Declaration
public async System.Threading.Tasks.Task<Authorizations> GetAuthorizationsAsync(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Authorizations> | Task of Authorizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsAsyncWithHttpInfo(String, String, String, String, String, CancellationToken)
List all authorizations
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorizations>> GetAuthorizationsAsyncWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Authorizations>> | Task of ApiResponse (Authorizations) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsAsyncWithIRestResponse(String, String, String, String, String, CancellationToken)
List all authorizations
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetAuthorizationsAsyncWithIRestResponse(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Authorizations) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsID(String, String)
Retrieve an authorization
Declaration
public Authorization GetAuthorizationsID(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Authorization | Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDAsync(String, String, CancellationToken)
Retrieve an authorization
Declaration
public async System.Threading.Tasks.Task<Authorization> GetAuthorizationsIDAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Authorization> | Task of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve an authorization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorization>> GetAuthorizationsIDAsyncWithHttpInfo(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Authorization>> | Task of ApiResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetAuthorizationsIDAsyncWithIRestResponse(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDWithHttpInfo(String, String)
Retrieve an authorization
Declaration
public ApiResponse<Authorization> GetAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Authorization> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDWithIRestResponse(String, String)
Retrieve an authorization
Declaration
public RestResponse GetAuthorizationsIDWithIRestResponse(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetAuthorizationsIDWithIRestResponseAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsIDWithRestRequest(String, String)
Retrieve an authorization
Declaration
public RestRequest GetAuthorizationsIDWithRestRequest(string authID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsWithHttpInfo(String, String, String, String, String)
List all authorizations
Declaration
public ApiResponse<Authorizations> GetAuthorizationsWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Authorizations> | ApiResponse of Authorizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsWithIRestResponse(String, String, String, String, String)
List all authorizations
Declaration
public RestResponse GetAuthorizationsWithIRestResponse(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Authorizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsWithIRestResponseAsync(String, String, String, String, String, CancellationToken)
List all authorizations
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetAuthorizationsWithIRestResponseAsync(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Authorizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetAuthorizationsWithRestRequest(String, String, String, String, String)
List all authorizations
Declaration
public RestRequest GetAuthorizationsWithRestRequest(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | userID | Only show authorizations that belong to a user ID. (optional) |
System.String | user | Only show authorizations that belong to a user name. (optional) |
System.String | orgID | Only show authorizations that belong to an organization ID. (optional) |
System.String | org | Only show authorizations that belong to a organization name. (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Authorizations |
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 |
PatchAuthorizationsID(String, AuthorizationUpdateRequest, String)
Update an authorization to be active or inactive
Declaration
public Authorization PatchAuthorizationsID(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Authorization | Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDAsync(String, AuthorizationUpdateRequest, String, CancellationToken)
Update an authorization to be active or inactive
Declaration
public async System.Threading.Tasks.Task<Authorization> PatchAuthorizationsIDAsync(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Authorization> | Task of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDAsyncWithHttpInfo(String, AuthorizationUpdateRequest, String, CancellationToken)
Update an authorization to be active or inactive
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorization>> PatchAuthorizationsIDAsyncWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Authorization>> | Task of ApiResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDAsyncWithIRestResponse(String, AuthorizationUpdateRequest, String, CancellationToken)
Update an authorization to be active or inactive
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchAuthorizationsIDAsyncWithIRestResponse(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDWithHttpInfo(String, AuthorizationUpdateRequest, String)
Update an authorization to be active or inactive
Declaration
public ApiResponse<Authorization> PatchAuthorizationsIDWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Authorization> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDWithIRestResponse(String, AuthorizationUpdateRequest, String)
Update an authorization to be active or inactive
Declaration
public RestResponse PatchAuthorizationsIDWithIRestResponse(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDWithIRestResponseAsync(String, AuthorizationUpdateRequest, String, CancellationToken)
Update an authorization to be active or inactive
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchAuthorizationsIDWithIRestResponseAsync(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchAuthorizationsIDWithRestRequest(String, AuthorizationUpdateRequest, String)
Update an authorization to be active or inactive
Declaration
public RestRequest PatchAuthorizationsIDWithRestRequest(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | authID | The ID of the authorization to update. |
AuthorizationUpdateRequest | authorizationUpdateRequest | Authorization to update |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizations(AuthorizationPostRequest, String)
Create an authorization
Declaration
public Authorization PostAuthorizations(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Authorization | Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsAsync(AuthorizationPostRequest, String, CancellationToken)
Create an authorization
Declaration
public async System.Threading.Tasks.Task<Authorization> PostAuthorizationsAsync(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Authorization> | Task of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsAsyncWithHttpInfo(AuthorizationPostRequest, String, CancellationToken)
Create an authorization
Declaration
public async System.Threading.Tasks.Task<ApiResponse<Authorization>> PostAuthorizationsAsyncWithHttpInfo(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization 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<Authorization>> | Task of ApiResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsAsyncWithIRestResponse(AuthorizationPostRequest, String, CancellationToken)
Create an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostAuthorizationsAsyncWithIRestResponse(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (Authorization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsWithHttpInfo(AuthorizationPostRequest, String)
Create an authorization
Declaration
public ApiResponse<Authorization> PostAuthorizationsWithHttpInfo(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Authorization> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsWithIRestResponse(AuthorizationPostRequest, String)
Create an authorization
Declaration
public RestResponse PostAuthorizationsWithIRestResponse(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsWithIRestResponseAsync(AuthorizationPostRequest, String, CancellationToken)
Create an authorization
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostAuthorizationsWithIRestResponseAsync(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Authorization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostAuthorizationsWithRestRequest(AuthorizationPostRequest, String)
Create an authorization
Declaration
public RestRequest PostAuthorizationsWithRestRequest(AuthorizationPostRequest authorizationPostRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
AuthorizationPostRequest | authorizationPostRequest | Authorization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Authorization |
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 |