Interface IAuthorizationsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IAuthorizationsService : IApiAccessor

Methods

DeleteAuthorizationsID(String, String)

Delete an authorization

Declaration

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

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

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

DeleteAuthorizationsIDWithHttpInfo(String, String)

Delete an authorization

Declaration

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

GetAuthorizations(String, String, String, String, String)

List all authorizations

Declaration

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

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

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

GetAuthorizationsID(String, String)

Retrieve an authorization

Declaration

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

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

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

GetAuthorizationsIDWithHttpInfo(String, String)

Retrieve an authorization

Declaration

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

GetAuthorizationsWithHttpInfo(String, String, String, String, String)

List all authorizations

Declaration

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

PatchAuthorizationsID(String, AuthorizationUpdateRequest, String)

Update an authorization to be active or inactive

Declaration

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

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

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

PatchAuthorizationsIDWithHttpInfo(String, AuthorizationUpdateRequest, String)

Update an authorization to be active or inactive

Declaration

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

PostAuthorizations(AuthorizationPostRequest, String)

Create an authorization

Declaration

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

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

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

PostAuthorizationsWithHttpInfo(AuthorizationPostRequest, String)

Create an authorization

Declaration

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