Interface IAuthorizationCodeFlow
OAuth 2.0 authorization code flow that manages and persists end-user credentials.
Inherited Members
Namespace: Google.Apis.Auth.OAuth2.Flows
Assembly: Google.Apis.Auth.dll
Syntax
public interface IAuthorizationCodeFlow : IDisposableProperties
AccessMethod
Gets the method for presenting the access token to the resource server.
Declaration
IAccessMethod AccessMethod { get; }Property Value
| Type | Description |
|---|---|
| IAccessMethod |
Clock
Gets the clock.
Declaration
IClock Clock { get; }Property Value
| Type | Description |
|---|---|
| IClock |
DataStore
Gets the data store used to store the credentials.
Declaration
IDataStore DataStore { get; }Property Value
| Type | Description |
|---|---|
| IDataStore |
Methods
CreateAuthorizationCodeRequest(string)
Creates an authorization code request with the specified redirect URI.
Declaration
AuthorizationCodeRequestUrl CreateAuthorizationCodeRequest(string redirectUri)Parameters
| Type | Name | Description |
|---|---|---|
| string | redirectUri |
Returns
| Type | Description |
|---|---|
| AuthorizationCodeRequestUrl |
DeleteTokenAsync(string, CancellationToken)
Asynchronously deletes the user's token using the flow's Google.Apis.Util.Store.IDataStore.
Declaration
Task DeleteTokenAsync(string userId, CancellationToken taskCancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | userId | User identifier. |
| CancellationToken | taskCancellationToken | Cancellation token to cancel operation. |
Returns
| Type | Description |
|---|---|
| Task |
ExchangeCodeForTokenAsync(string, string, string, CancellationToken)
Asynchronously exchanges an authorization code for an access token.
Declaration
Task<TokenResponse> ExchangeCodeForTokenAsync(string userId, string code, string redirectUri, CancellationToken taskCancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | userId | User identifier. |
| string | code | Authorization code received from the authorization server. |
| string | redirectUri | Redirect URI which is used in the token request. |
| CancellationToken | taskCancellationToken | Cancellation token to cancel operation. |
Returns
| Type | Description |
|---|---|
| Task<TokenResponse> | Token response which contains the access token. |
LoadTokenAsync(string, CancellationToken)
Asynchronously loads the user's token using the flow's Google.Apis.Util.Store.IDataStore.
Declaration
Task<TokenResponse> LoadTokenAsync(string userId, CancellationToken taskCancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | userId | User identifier |
| CancellationToken | taskCancellationToken | Cancellation token to cancel operation |
Returns
| Type | Description |
|---|---|
| Task<TokenResponse> | Token response |
RefreshTokenAsync(string, string, CancellationToken)
Asynchronously refreshes an access token using a refresh token.
Declaration
Task<TokenResponse> RefreshTokenAsync(string userId, string refreshToken, CancellationToken taskCancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | userId | User identifier. |
| string | refreshToken | Refresh token which is used to get a new access token. |
| CancellationToken | taskCancellationToken | Cancellation token to cancel operation. |
Returns
| Type | Description |
|---|---|
| Task<TokenResponse> | Token response which contains the access token and the input refresh token. |
RevokeTokenAsync(string, string, CancellationToken)
Asynchronously revokes the specified token. This method disconnects the user's account from the OAuth 2.0 application. It should be called upon removing the user account from the site.
Declaration
Task RevokeTokenAsync(string userId, string token, CancellationToken taskCancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| string | userId | User identifier. |
| string | token | Access token to be revoked. |
| CancellationToken | taskCancellationToken | Cancellation token to cancel operation. |
Returns
| Type | Description |
|---|---|
| Task |
|
Remarks
If revoking the token succeeds, the user's credential is removed from the data store and the user MUST authorize the application again before the application can access the user's private resources.
ShouldForceTokenRetrieval()
Indicates if a new token needs to be retrieved and stored regardless of normal circumstances.
Declaration
bool ShouldForceTokenRetrieval()Returns
| Type | Description |
|---|---|
| bool |