Class AuthenticationApiClient -
+Client for the Auth0 Authentication API.
Inherited Members
Namespace: Auth0.AuthenticationApi
+Namespace: Auth0.AuthenticationApi
Assembly: Auth0.AuthenticationApi.dll
Syntax
Remarks
Full documentation on the Auth0 Authentication API is available at https://auth0.com/docs/api/authentication
Constructors
-
+
- AuthenticationApiClient(String, IAuthenticationConnection)
+ AuthenticationApiClient(string, IAuthenticationConnection)
Initializes a new instance of the AuthenticationApiClient class.
- Declaration
+ Declaration
public AuthenticationApiClient(string domain, IAuthenticationConnection connection = null)
Parameters
-
+
Type
@@ -141,7 +141,7 @@ Parameters
- System.String
+ string
domain
Your Auth0 domain name, e.g. tenant.auth0.com.
@@ -150,28 +150,28 @@ Parameters
IAuthenticationConnection
connection
Optional IAuthenticationConnection used to influence connection behavior.
-Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient.
+Defaults to a freshly created HttpClientAuthenticationConnection that uses a single HttpClient.
Remarks
- To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a
-HttpClientAuthenticationConnection passing that into the constructor. e.g.
-var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpClient));
or
-var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
+ To use a custom HttpClient or HttpMessageHandler create a
+HttpClientAuthenticationConnection passing that into the constructor. e.g.
+
var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpClient));
or
+var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
AuthenticationApiClient(Uri, IAuthenticationConnection)
Initializes a new instance of the AuthenticationApiClient class.
- Declaration
+ Declaration
public AuthenticationApiClient(Uri baseUri, IAuthenticationConnection connection = null)
Parameters
-
+
Type
@@ -181,7 +181,7 @@ Parameters
- System.Uri
+ Uri
baseUri
Your Auth0 domain URI, e.g. https://tenant.auth0.com
@@ -190,28 +190,28 @@ Parameters
IAuthenticationConnection
connection
Optional IAuthenticationConnection used to influence connection behavior.
-Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient.
+Defaults to a freshly created HttpClientAuthenticationConnection that uses a single HttpClient.
Remarks
- To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a
-HttpClientAuthenticationConnection passing that into the constructor. e.g.
-var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpClient));
or
-var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
+ To use a custom HttpClient or HttpMessageHandler create a
+HttpClientAuthenticationConnection passing that into the constructor. e.g.
+
var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpClient));
or
+var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
Fields
-
+
connection
- Declaration
+ Declaration
protected readonly IAuthenticationConnection connection
Field Value
-
+
Type
@@ -226,18 +226,18 @@ Field Value
Properties
-
+
BaseUri
Base URI that will be used for all the requests.
- Declaration
+ Declaration
public Uri BaseUri { get; }
Property Value
-
+
Type
@@ -246,24 +246,24 @@ Property Value
- System.Uri
+ Uri
Methods
-
+
ChangePasswordAsync(ChangePasswordRequest, CancellationToken)
Requests a password change email for a given email address and connection.
- Declaration
+ Declaration
- public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -279,7 +279,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -287,7 +287,7 @@ Parameters
Returns
-
+
Type
@@ -296,8 +296,8 @@ Returns
- System.Threading.Tasks.Task<System.String>
- System.Threading.Tasks.Task representing the async operation containing either the JSON error response or the plain text success message response.
+ Task<string>
+ Task representing the async operation containing either the JSON error response or the plain text success message response.
@@ -307,21 +307,21 @@ Disposes of any owned disposable resources such as a IAuthenticationConnection.
- Declaration
+ Declaration
public void Dispose()
- Dispose(Boolean)
+ Dispose(bool)
Disposes of any owned disposable resources such as a IAuthenticationConnection.
- Declaration
+ Declaration
protected virtual void Dispose(bool disposing)
Parameters
-
+
Type
@@ -331,9 +331,9 @@ Parameters
- System.Boolean
+ bool
disposing
- Whether we are actually disposing (true) or not (false).
+
@@ -343,12 +343,12 @@ Obtains a one-time link that can be used to log in as a specific user.
- Declaration
+ Declaration
- public async Task<Uri> GetImpersonationUrlAsync(ImpersonationRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<Uri> GetImpersonationUrlAsync(ImpersonationRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -364,7 +364,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -372,7 +372,7 @@ Parameters
Returns
-
+
Type
@@ -381,8 +381,8 @@ Returns
- System.Threading.Tasks.Task<System.Uri>
- System.Threading.Tasks.Task which can be used to sign in as the specified user.
+ Task<Uri>
+ Task which can be used to sign in as the specified user.
@@ -395,12 +395,12 @@ Exchanges an Authorization Code using PKCE for an Access Token.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodePkceTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodePkceTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -416,7 +416,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -424,7 +424,7 @@ Parameters
Returns
-
+
Type
@@ -433,9 +433,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -445,12 +445,12 @@ Exchanges an Authorization Code for an Access Token.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodeTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(AuthorizationCodeTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -466,7 +466,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -474,7 +474,7 @@ Parameters
Returns
-
+
Type
@@ -483,9 +483,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -495,12 +495,12 @@ Requests an Access Token using the Client Credentials Grant flow.
- Declaration
+ Declaration
- public Task<AccessTokenResponse> GetTokenAsync(ClientCredentialsTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(ClientCredentialsTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -513,11 +513,11 @@ Parameters
ClientCredentialsTokenRequest
request
ClientCredentialsTokenRequest containing
- client and audience details of the request.
+client and audience details of the request.
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -525,7 +525,7 @@ Parameters
Returns
-
+
Type
@@ -534,9 +534,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -546,12 +546,12 @@ Requests an Access Token using the Device Authorization flow
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(DeviceCodeTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(DeviceCodeTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -567,7 +567,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -575,7 +575,7 @@ Parameters
Returns
-
+
Type
@@ -584,9 +584,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -599,12 +599,12 @@ Requests an Access Token using the Passwordless flow through email.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessEmailTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(PasswordlessEmailTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -620,7 +620,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -628,7 +628,7 @@ Parameters
Returns
-
+
Type
@@ -637,9 +637,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -649,12 +649,12 @@ Requests an Access Token using the Passwordless flow through SMS.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(PasswordlessSmsTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(PasswordlessSmsTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -670,7 +670,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -678,7 +678,7 @@ Parameters
Returns
-
+
Type
@@ -687,9 +687,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -699,12 +699,12 @@ Refreshes all tokens by way of the the Refresh Token obtained during authorization.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(RefreshTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(RefreshTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -720,7 +720,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -728,7 +728,7 @@ Parameters
Returns
-
+
Type
@@ -737,9 +737,9 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
@@ -749,12 +749,12 @@ Performs authentication by providing user-supplied information in a ResourceOwnerTokenRequest.
- Declaration
+ Declaration
- public async Task<AccessTokenResponse> GetTokenAsync(ResourceOwnerTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<AccessTokenResponse> GetTokenAsync(ResourceOwnerTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -770,7 +770,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -778,7 +778,7 @@ Parameters
Returns
-
+
Type
@@ -787,28 +787,28 @@ Returns
- System.Threading.Tasks.Task<AccessTokenResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a AccessTokenResponse with the requested tokens.
+ Task<AccessTokenResponse>
+ Task representing the async operation containing
+a AccessTokenResponse with the requested tokens.
Remarks
- The grant_type parameter required by the /oauth/token endpoint will automatically be inferred from the request
parameter. If no Realm was specified,
-then the grant_type will be set to "password". If a Realm was specified, then the grant_type will be set to "http://auth0.com/oauth/grant-type/password-realm"
+ The grant_type parameter required by the /oauth/token endpoint will automatically be inferred from the request
parameter. If no Realm was specified,
+then the grant_type will be set to "password". If a Realm was specified, then the grant_type will be set to "http://auth0.com/oauth/grant-type/password-realm"
- GetUserInfoAsync(String, CancellationToken)
+ GetUserInfoAsync(string, CancellationToken)
Returns user information based on the access token that was obtained during login.
- Declaration
+ Declaration
- public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -818,13 +818,13 @@ Parameters
- System.String
+ string
accessToken
Access token used to obtain the user information.
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -832,7 +832,7 @@ Parameters
Returns
-
+
Type
@@ -841,8 +841,8 @@ Returns
- System.Threading.Tasks.Task<UserInfo>
- System.Threading.Tasks.Task representing the async operation containing the
+
Task<UserInfo>
+ Task representing the async operation containing the
UserInfo requested..
@@ -856,12 +856,12 @@ Revokes refresh token provided in request.
- Declaration
+ Declaration
- public Task RevokeRefreshTokenAsync(RevokeRefreshTokenRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task RevokeRefreshTokenAsync(RevokeRefreshTokenRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -877,7 +877,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -885,7 +885,7 @@ Parameters
Returns
-
+
Type
@@ -894,8 +894,8 @@ Returns
- System.Threading.Tasks.Task
- System.Threading.Tasks.Task representing the async operation.
+ Task
+ Task representing the async operation.
@@ -905,12 +905,12 @@ Creates a new user given the user details specified.
- Declaration
+ Declaration
- public Task<SignupUserResponse> SignupUserAsync(SignupUserRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<SignupUserResponse> SignupUserAsync(SignupUserRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -926,7 +926,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -934,7 +934,7 @@ Parameters
Returns
-
+
Type
@@ -943,9 +943,9 @@ Returns
- System.Threading.Tasks.Task<SignupUserResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a SignupUserResponse with the information of the signed up user.
+ Task<SignupUserResponse>
+ Task representing the async operation containing
+a SignupUserResponse with the information of the signed up user.
@@ -955,12 +955,12 @@ Starts a new Device Authorization flow
- Declaration
+ Declaration
- public Task<DeviceCodeResponse> StartDeviceFlowAsync(DeviceCodeRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<DeviceCodeResponse> StartDeviceFlowAsync(DeviceCodeRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -976,7 +976,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -984,7 +984,7 @@ Parameters
Returns
-
+
Type
@@ -993,9 +993,9 @@ Returns
- System.Threading.Tasks.Task<DeviceCodeResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a DeviceCodeResponse with the details of the request.
+ Task<DeviceCodeResponse>
+ Task representing the async operation containing
+a DeviceCodeResponse with the details of the request.
@@ -1005,12 +1005,12 @@ Starts a new Passwordless email flow.
- Declaration
+ Declaration
- public Task<PasswordlessEmailResponse> StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<PasswordlessEmailResponse> StartPasswordlessEmailFlowAsync(PasswordlessEmailRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -1026,7 +1026,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -1034,7 +1034,7 @@ Parameters
Returns
-
+
Type
@@ -1043,9 +1043,9 @@ Returns
- System.Threading.Tasks.Task<PasswordlessEmailResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a PasswordlessEmailResponse with the information of the signed up user.
+ Task<PasswordlessEmailResponse>
+ Task representing the async operation containing
+a PasswordlessEmailResponse with the information of the signed up user.
@@ -1055,12 +1055,12 @@ Starts a new Passwordless SMS flow.
- Declaration
+ Declaration
- public Task<PasswordlessSmsResponse> StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<PasswordlessSmsResponse> StartPasswordlessSmsFlowAsync(PasswordlessSmsRequest request, CancellationToken cancellationToken = default)
Parameters
-
+
Type
@@ -1076,7 +1076,7 @@ Parameters
- System.Threading.CancellationToken
+ CancellationToken
cancellationToken
The cancellation token to cancel operation.
@@ -1084,7 +1084,7 @@ Parameters
Returns
-
+
Type
@@ -1093,9 +1093,9 @@ Returns
- System.Threading.Tasks.Task<PasswordlessSmsResponse>
- System.Threading.Tasks.Task representing the async operation containing
- a PasswordlessSmsResponse with the details of the request.
+ Task<PasswordlessSmsResponse>
+ Task representing the async operation containing
+a PasswordlessSmsResponse with the details of the request.
@@ -1105,7 +1105,7 @@ Implements
IAuthenticationApiClient
- System.IDisposable
+ IDisposable
Extension Methods
@@ -1115,25 +1115,26 @@ Extension Methods
AuthenticationApiClientExtensions.BuildLogoutUrl(IAuthenticationApiClient)
- AuthenticationApiClientExtensions.BuildSamlUrl(IAuthenticationApiClient, String)
+ AuthenticationApiClientExtensions.BuildSamlUrl(IAuthenticationApiClient, string)
+
-
+
-
+
-
-
+
+
diff --git a/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html b/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
index 3aa0ffd6c..5d31684f9 100644
--- a/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
+++ b/docs/api/Auth0.AuthenticationApi.AuthenticationApiClientExtensions.html
@@ -1,23 +1,22 @@
-
+
-
- Class AuthenticationApiClientExtensions
-
-
-
-
+
+ Class AuthenticationApiClientExtensions
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
@@ -25,7 +24,7 @@
-
+
-
+
Full documentation on the Auth0 Authentication API is available at https://auth0.com/docs/api/authentication
Initializes a new instance of the AuthenticationApiClient class.
public AuthenticationApiClient(string domain, IAuthenticationConnection connection = null)
Type | @@ -141,7 +141,7 @@||||||
---|---|---|---|---|---|---|
System.String | +string | domain | Your Auth0 domain name, e.g. tenant.auth0.com. |
@@ -150,28 +150,28 @@ IAuthenticationConnection | connection | Optional IAuthenticationConnection used to influence connection behavior. -Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient. +Defaults to a freshly created HttpClientAuthenticationConnection that uses a single HttpClient. |
Remarks
-To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a -HttpClientAuthenticationConnection passing that into the constructor. e.g.
-var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpClient));
or
-var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
+ To use a custom HttpClient or HttpMessageHandler create a +HttpClientAuthenticationConnection passing that into the constructor. e.g. +
var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpClient));
or
+var client = new AuthenticationApiClient(domain, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
AuthenticationApiClient(Uri, IAuthenticationConnection)
Initializes a new instance of the AuthenticationApiClient class.
Declaration
+Declaration
public AuthenticationApiClient(Uri baseUri, IAuthenticationConnection connection = null)
Parameters
-Type | @@ -181,7 +181,7 @@||||||
---|---|---|---|---|---|---|
System.Uri | +Uri | baseUri | Your Auth0 domain URI, e.g. https://tenant.auth0.com |
@@ -190,28 +190,28 @@ IAuthenticationConnection | connection | Optional IAuthenticationConnection used to influence connection behavior. -Defaults to a freshly created HttpClientAuthenticationConnection that uses a single System.Net.Http.HttpClient. +Defaults to a freshly created HttpClientAuthenticationConnection that uses a single HttpClient. |
Remarks
-To use a custom System.Net.Http.HttpClient or System.Net.Http.HttpMessageHandler create a -HttpClientAuthenticationConnection passing that into the constructor. e.g.
-var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpClient));
or
-var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
+ To use a custom HttpClient or HttpMessageHandler create a +HttpClientAuthenticationConnection passing that into the constructor. e.g. +
var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpClient));
or
+var client = new AuthenticationApiClient(baseUri, new HttpClientAuthenticationConnection(myHttpMessageHandler));
or
Fields -
+connection
-Declaration
+Declaration
protected readonly IAuthenticationConnection connection
Field Value
-Type | @@ -226,18 +226,18 @@
---|
Properties -
+BaseUri
Base URI that will be used for all the requests.
Declaration
+Declaration
public Uri BaseUri { get; }
Property Value
-Type | @@ -246,24 +246,24 @@||
---|---|---|
System.Uri | +Uri |
Methods -
+ChangePasswordAsync(ChangePasswordRequest, CancellationToken)
Requests a password change email for a given email address and connection.
Declaration
+Declaration
public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<string> ChangePasswordAsync(ChangePasswordRequest request, CancellationToken cancellationToken = default)
Parameters
-Type | @@ -279,7 +279,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -287,7 +287,7 @@
Returns
-Type | @@ -296,8 +296,8 @@||||
---|---|---|---|---|
System.Threading.Tasks.Task<System.String> | -System.Threading.Tasks.Task representing the async operation containing either the JSON error response or the plain text success message response. + | Task<string> | +Task representing the async operation containing either the JSON error response or the plain text success message response. |
Type | @@ -331,9 +331,9 @@||||
---|---|---|---|---|
System.Boolean | +bool | disposing | -Whether we are actually disposing (true) or not (false). + |
Type | @@ -364,7 +364,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -372,7 +372,7 @@
Returns
-Type | @@ -381,8 +381,8 @@|||
---|---|---|---|
System.Threading.Tasks.Task<System.Uri> | -System.Threading.Tasks.Task which can be used to sign in as the specified user. + | Task<Uri> | +Task which can be used to sign in as the specified user. |
Type | @@ -416,7 +416,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -424,7 +424,7 @@
Returns
-Type | @@ -433,9 +433,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -466,7 +466,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -474,7 +474,7 @@
Returns
-Type | @@ -483,9 +483,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -513,11 +513,11 @@ClientCredentialsTokenRequest | request | ClientCredentialsTokenRequest containing - client and audience details of the request. +client and audience details of the request. |
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -525,7 +525,7 @@
Returns
-Type | @@ -534,9 +534,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -567,7 +567,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -575,7 +575,7 @@
Returns
-Type | @@ -584,9 +584,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -620,7 +620,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -628,7 +628,7 @@
Returns
-Type | @@ -637,9 +637,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -670,7 +670,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -678,7 +678,7 @@
Returns
-Type | @@ -687,9 +687,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -720,7 +720,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -728,7 +728,7 @@
Returns
-Type | @@ -737,9 +737,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Type | @@ -770,7 +770,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -778,7 +778,7 @@
Returns
-Type | @@ -787,28 +787,28 @@|||
---|---|---|---|
System.Threading.Tasks.Task<AccessTokenResponse> | -System.Threading.Tasks.Task representing the async operation containing - a AccessTokenResponse with the requested tokens. + | Task<AccessTokenResponse> | +Task representing the async operation containing +a AccessTokenResponse with the requested tokens. |
Remarks
-The grant_type parameter required by the /oauth/token endpoint will automatically be inferred from the request
parameter. If no Realm was specified,
-then the grant_type will be set to "password". If a Realm was specified, then the grant_type will be set to "http://auth0.com/oauth/grant-type/password-realm"
The grant_type parameter required by the /oauth/token endpoint will automatically be inferred from the request
parameter. If no Realm was specified,
+then the grant_type will be set to "password". If a Realm was specified, then the grant_type will be set to "http://auth0.com/oauth/grant-type/password-realm"
GetUserInfoAsync(String, CancellationToken)
+GetUserInfoAsync(string, CancellationToken)
Returns user information based on the access token that was obtained during login.
Declaration
+Declaration
public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = default(CancellationToken))
+ public Task<UserInfo> GetUserInfoAsync(string accessToken, CancellationToken cancellationToken = default)
Parameters
-Type | @@ -818,13 +818,13 @@|||
---|---|---|---|
System.String | +string | accessToken | Access token used to obtain the user information. |
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -832,7 +832,7 @@
Returns
-Type | @@ -841,8 +841,8 @@|||
---|---|---|---|
System.Threading.Tasks.Task<UserInfo> | -System.Threading.Tasks.Task representing the async operation containing the + | Task<UserInfo> | +Task representing the async operation containing the UserInfo requested.. |
Type | @@ -877,7 +877,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -885,7 +885,7 @@
Returns
-Type | @@ -894,8 +894,8 @@|||
---|---|---|---|
System.Threading.Tasks.Task | -System.Threading.Tasks.Task representing the async operation. + | Task | +Task representing the async operation. |
Type | @@ -926,7 +926,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -934,7 +934,7 @@
Returns
-Type | @@ -943,9 +943,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<SignupUserResponse> | -System.Threading.Tasks.Task representing the async operation containing - a SignupUserResponse with the information of the signed up user. + | Task<SignupUserResponse> | +Task representing the async operation containing +a SignupUserResponse with the information of the signed up user. |
Type | @@ -976,7 +976,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -984,7 +984,7 @@
Returns
-Type | @@ -993,9 +993,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<DeviceCodeResponse> | -System.Threading.Tasks.Task representing the async operation containing - a DeviceCodeResponse with the details of the request. + | Task<DeviceCodeResponse> | +Task representing the async operation containing +a DeviceCodeResponse with the details of the request. |
Type | @@ -1026,7 +1026,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1034,7 +1034,7 @@
Returns
-Type | @@ -1043,9 +1043,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<PasswordlessEmailResponse> | -System.Threading.Tasks.Task representing the async operation containing - a PasswordlessEmailResponse with the information of the signed up user. + | Task<PasswordlessEmailResponse> | +Task representing the async operation containing +a PasswordlessEmailResponse with the information of the signed up user. |
Type | @@ -1076,7 +1076,7 @@|||
---|---|---|---|
System.Threading.CancellationToken | +CancellationToken | cancellationToken | The cancellation token to cancel operation. |
@@ -1084,7 +1084,7 @@
Returns
-Type | @@ -1093,9 +1093,9 @@|||
---|---|---|---|
System.Threading.Tasks.Task<PasswordlessSmsResponse> | -System.Threading.Tasks.Task representing the async operation containing - a PasswordlessSmsResponse with the details of the request. + | Task<PasswordlessSmsResponse> | +Task representing the async operation containing +a PasswordlessSmsResponse with the details of the request. |