Class SigninService
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 SigninService : object, ISigninService, IApiAccessor
Constructors
SigninService(Configuration)
Initializes a new instance of the SigninService class using Configuration object
Declaration
public SigninService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
SigninService(String)
Initializes a new instance of the SigninService class.
Declaration
public SigninService(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 |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
PostSignin(String, String)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public void PostSignin(string zapTraceSpan = null, string authorization = null)
Parameters
Type | Name | Description |
---|---|---|
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 |
PostSigninAsync(String, String, CancellationToken)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public System.Threading.Tasks.Task PostSigninAsync(string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
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 |
PostSigninAsyncWithHttpInfo(String, String, CancellationToken)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> PostSigninAsyncWithHttpInfo(string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
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 |
PostSigninAsyncWithIRestResponse(String, String, CancellationToken)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostSigninAsyncWithIRestResponse(string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | authorization | An auth credential for the Basic scheme (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninWithHttpInfo(String, String)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public ApiResponse<object> PostSigninWithHttpInfo(string zapTraceSpan = null, string authorization = null)
Parameters
Type | Name | Description |
---|---|---|
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 |
PostSigninWithIRestResponse(String, String)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public RestResponse PostSigninWithIRestResponse(string zapTraceSpan = null, string authorization = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | authorization | An auth credential for the Basic scheme (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninWithIRestResponseAsync(String, String, CancellationToken)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostSigninWithIRestResponseAsync(string zapTraceSpan = null, string authorization = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | authorization | An auth credential for the Basic scheme (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninWithRestRequest(String, String)
Create a user session. Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Declaration
public RestRequest PostSigninWithRestRequest(string zapTraceSpan = null, string authorization = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | authorization | An auth credential for the Basic scheme (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
SetBasePath(String)
Sets the base path of the API client.
Declaration
public void SetBasePath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |