Interface ISigninService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface ISigninService : IApiAccessor
Methods
PostSignin(String, String)
Create a user session.
Declaration
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) |
Remarks
Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninAsync(String, String, CancellationToken)
Create a user session.
Declaration
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 |
Remarks
Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninAsyncWithHttpInfo(String, String, CancellationToken)
Create a user session.
Declaration
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 |
Remarks
Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSigninWithHttpInfo(String, String)
Create a user session.
Declaration
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) |
Remarks
Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |