Interface ILegacyAuthorizationsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ILegacyAuthorizationsService : IApiAccessor

Methods

DeleteLegacyAuthorizationsID(String, String)

Delete a legacy authorization

Declaration

void DeleteLegacyAuthorizationsID(string authID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

DeleteLegacyAuthorizationsIDAsync(String, String, CancellationToken)

Delete a legacy authorization

Declaration

System.Threading.Tasks.Task DeleteLegacyAuthorizationsIDAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

DeleteLegacyAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a legacy authorization

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteLegacyAuthorizationsIDAsyncWithHttpInfo(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

DeleteLegacyAuthorizationsIDWithHttpInfo(String, String)

Delete a legacy authorization

Declaration

ApiResponse<object> DeleteLegacyAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

GetLegacyAuthorizations(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration

Authorizations GetLegacyAuthorizations(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	userID	Only show legacy authorizations that belong to a user ID. (optional)
System.String	user	Only show legacy authorizations that belong to a user name. (optional)
System.String	orgID	Only show legacy authorizations that belong to an organization ID. (optional)
System.String	org	Only show legacy authorizations that belong to a organization name. (optional)
System.String	token	Only show legacy authorizations with a specified token (auth name). (optional)
System.String	authID	Only show legacy authorizations with a specified auth ID. (optional)

Returns

Type	Description
Authorizations	Authorizations

Exceptions

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

GetLegacyAuthorizationsAsync(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration

System.Threading.Tasks.Task<Authorizations> GetLegacyAuthorizationsAsync(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	userID	Only show legacy authorizations that belong to a user ID. (optional)
System.String	user	Only show legacy authorizations that belong to a user name. (optional)
System.String	orgID	Only show legacy authorizations that belong to an organization ID. (optional)
System.String	org	Only show legacy authorizations that belong to a organization name. (optional)
System.String	token	Only show legacy authorizations with a specified token (auth name). (optional)
System.String	authID	Only show legacy authorizations with a specified auth ID. (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

GetLegacyAuthorizationsAsyncWithHttpInfo(String, String, String, String, String, String, String, CancellationToken)

List all legacy authorizations

Declaration

System.Threading.Tasks.Task<ApiResponse<Authorizations>> GetLegacyAuthorizationsAsyncWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	userID	Only show legacy authorizations that belong to a user ID. (optional)
System.String	user	Only show legacy authorizations that belong to a user name. (optional)
System.String	orgID	Only show legacy authorizations that belong to an organization ID. (optional)
System.String	org	Only show legacy authorizations that belong to a organization name. (optional)
System.String	token	Only show legacy authorizations with a specified token (auth name). (optional)
System.String	authID	Only show legacy authorizations with a specified auth ID. (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

GetLegacyAuthorizationsID(String, String)

Retrieve a legacy authorization

Declaration

Authorization GetLegacyAuthorizationsID(string authID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

GetLegacyAuthorizationsIDAsync(String, String, CancellationToken)

Retrieve a legacy authorization

Declaration

System.Threading.Tasks.Task<Authorization> GetLegacyAuthorizationsIDAsync(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

GetLegacyAuthorizationsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a legacy authorization

Declaration

System.Threading.Tasks.Task<ApiResponse<Authorization>> GetLegacyAuthorizationsIDAsyncWithHttpInfo(string authID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

GetLegacyAuthorizationsIDWithHttpInfo(String, String)

Retrieve a legacy authorization

Declaration

ApiResponse<Authorization> GetLegacyAuthorizationsIDWithHttpInfo(string authID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy 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

GetLegacyAuthorizationsWithHttpInfo(String, String, String, String, String, String, String)

List all legacy authorizations

Declaration

ApiResponse<Authorizations> GetLegacyAuthorizationsWithHttpInfo(string zapTraceSpan = null, string userID = null, string user = null, string orgID = null, string org = null, string token = null, string authID = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	userID	Only show legacy authorizations that belong to a user ID. (optional)
System.String	user	Only show legacy authorizations that belong to a user name. (optional)
System.String	orgID	Only show legacy authorizations that belong to an organization ID. (optional)
System.String	org	Only show legacy authorizations that belong to a organization name. (optional)
System.String	token	Only show legacy authorizations with a specified token (auth name). (optional)
System.String	authID	Only show legacy authorizations with a specified auth ID. (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

PatchLegacyAuthorizationsID(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration

Authorization PatchLegacyAuthorizationsID(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
AuthorizationUpdateRequest	authorizationUpdateRequest	Legacy 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

PatchLegacyAuthorizationsIDAsync(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

Declaration

System.Threading.Tasks.Task<Authorization> PatchLegacyAuthorizationsIDAsync(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
AuthorizationUpdateRequest	authorizationUpdateRequest	Legacy 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

PatchLegacyAuthorizationsIDAsyncWithHttpInfo(String, AuthorizationUpdateRequest, String, CancellationToken)

Update a legacy authorization to be active or inactive

Declaration

System.Threading.Tasks.Task<ApiResponse<Authorization>> PatchLegacyAuthorizationsIDAsyncWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
AuthorizationUpdateRequest	authorizationUpdateRequest	Legacy 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

PatchLegacyAuthorizationsIDWithHttpInfo(String, AuthorizationUpdateRequest, String)

Update a legacy authorization to be active or inactive

Declaration

ApiResponse<Authorization> PatchLegacyAuthorizationsIDWithHttpInfo(string authID, AuthorizationUpdateRequest authorizationUpdateRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
AuthorizationUpdateRequest	authorizationUpdateRequest	Legacy 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

PostLegacyAuthorizations(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration

Authorization PostLegacyAuthorizations(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
LegacyAuthorizationPostRequest	legacyAuthorizationPostRequest	Legacy 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

PostLegacyAuthorizationsAsync(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

Declaration

System.Threading.Tasks.Task<Authorization> PostLegacyAuthorizationsAsync(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
LegacyAuthorizationPostRequest	legacyAuthorizationPostRequest	Legacy 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

PostLegacyAuthorizationsAsyncWithHttpInfo(LegacyAuthorizationPostRequest, String, CancellationToken)

Create a legacy authorization

Declaration

System.Threading.Tasks.Task<ApiResponse<Authorization>> PostLegacyAuthorizationsAsyncWithHttpInfo(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
LegacyAuthorizationPostRequest	legacyAuthorizationPostRequest	Legacy 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

PostLegacyAuthorizationsIDPassword(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration

void PostLegacyAuthorizationsIDPassword(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
PasswordResetBody	passwordResetBody	New password
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

PostLegacyAuthorizationsIDPasswordAsync(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

Declaration

System.Threading.Tasks.Task PostLegacyAuthorizationsIDPasswordAsync(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
PasswordResetBody	passwordResetBody	New password
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

PostLegacyAuthorizationsIDPasswordAsyncWithHttpInfo(String, PasswordResetBody, String, CancellationToken)

Set a legacy authorization password

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> PostLegacyAuthorizationsIDPasswordAsyncWithHttpInfo(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
PasswordResetBody	passwordResetBody	New password
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

PostLegacyAuthorizationsIDPasswordWithHttpInfo(String, PasswordResetBody, String)

Set a legacy authorization password

Declaration

ApiResponse<object> PostLegacyAuthorizationsIDPasswordWithHttpInfo(string authID, PasswordResetBody passwordResetBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	authID	The ID of the legacy authorization to update.
PasswordResetBody	passwordResetBody	New password
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

PostLegacyAuthorizationsWithHttpInfo(LegacyAuthorizationPostRequest, String)

Create a legacy authorization

Declaration

ApiResponse<Authorization> PostLegacyAuthorizationsWithHttpInfo(LegacyAuthorizationPostRequest legacyAuthorizationPostRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
LegacyAuthorizationPostRequest	legacyAuthorizationPostRequest	Legacy 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