Class GoogleWebAuthorizationBroker (1.55.0)

Stay organized with collections Save and categorize content based on your preferences.
public class GoogleWebAuthorizationBroker

A helper utility to manage the authorization code flow.

Inheritance

Object > GoogleWebAuthorizationBroker

Namespace

Google.Apis.Auth.OAuth2

Assembly

Google.Apis.Auth.dll

Remarks

This class is only suitable for client-side use, as it starts a local browser that requires user interaction. Do not use this class when executing on a web server, or any cases where the authenticating end-user is not able to do directly interact with a launched browser.

Fields

Folder

public static string Folder

The folder which is used by the FileDataStore.

Field Value
TypeDescription
String
Remarks

The reason that this is not 'private const' is that a user can change it and store the credentials in a different location.

Methods

AuthorizeAsync(ClientSecrets, IEnumerable<String>, String, CancellationToken, IDataStore, ICodeReceiver)

public static Task<UserCredential> AuthorizeAsync(ClientSecrets clientSecrets, IEnumerable<string> scopes, string user, CancellationToken taskCancellationToken, IDataStore dataStore = null, ICodeReceiver codeReceiver = null)

Asynchronously authorizes the specified user. Requires user interaction; see GoogleWebAuthorizationBroker remarks for more details.

Parameters
NameDescription
clientSecretsClientSecrets

The client secrets.

scopesIEnumerable<String>

The scopes which indicate the Google API access your application is requesting.

userString

The user to authorize.

taskCancellationTokenCancellationToken

Cancellation token to cancel an operation.

dataStoreIDataStore

The data store, if not specified a file data store will be used.

codeReceiverICodeReceiver

The code receiver, if not specified a local server code receiver will be used.

Returns
TypeDescription
Task<UserCredential>

User credential.

Remarks

In case no data store is specified, FileDataStore will be used by default.

AuthorizeAsync(GoogleAuthorizationCodeFlow.Initializer, IEnumerable<String>, String, CancellationToken, IDataStore, ICodeReceiver)

public static Task<UserCredential> AuthorizeAsync(GoogleAuthorizationCodeFlow.Initializer initializer, IEnumerable<string> scopes, string user, CancellationToken taskCancellationToken, IDataStore dataStore = null, ICodeReceiver codeReceiver = null)

The core logic for asynchronously authorizing the specified user. Requires user interaction; see GoogleWebAuthorizationBroker remarks for more details.

Parameters
NameDescription
initializerGoogleAuthorizationCodeFlow.Initializer

The authorization code initializer.

scopesIEnumerable<String>

The scopes which indicate the Google API access your application is requesting.

userString

The user to authorize.

taskCancellationTokenCancellationToken

Cancellation token to cancel an operation.

dataStoreIDataStore

The data store, if not specified a file data store will be used.

codeReceiverICodeReceiver

The code receiver, if not specified a local server code receiver will be used.

Returns
TypeDescription
Task<UserCredential>

User credential.

AuthorizeAsync(Stream, IEnumerable<String>, String, CancellationToken, IDataStore, ICodeReceiver)

public static Task<UserCredential> AuthorizeAsync(Stream clientSecretsStream, IEnumerable<string> scopes, string user, CancellationToken taskCancellationToken, IDataStore dataStore = null, ICodeReceiver codeReceiver = null)

Asynchronously authorizes the specified user. Requires user interaction; see GoogleWebAuthorizationBroker remarks for more details.

Parameters
NameDescription
clientSecretsStreamStream

The client secrets stream. The authorization code flow constructor is responsible for disposing the stream.

scopesIEnumerable<String>

The scopes which indicate the Google API access your application is requesting.

userString

The user to authorize.

taskCancellationTokenCancellationToken

Cancellation token to cancel an operation.

dataStoreIDataStore

The data store, if not specified a file data store will be used.

codeReceiverICodeReceiver

The code receiver, if not specified a local server code receiver will be used.

Returns
TypeDescription
Task<UserCredential>

User credential.

Remarks

In case no data store is specified, FileDataStore will be used by default.

ReauthorizeAsync(UserCredential, CancellationToken, ICodeReceiver)

public static Task ReauthorizeAsync(UserCredential userCredential, CancellationToken taskCancellationToken, ICodeReceiver codeReceiver = null)

Asynchronously reauthorizes the user. This method should be called if the users want to authorize after they revoked the token. Requires user interaction; see GoogleWebAuthorizationBroker remarks for more details.

Parameters
NameDescription
userCredentialUserCredential

The current user credential. Its Token will be updated.

taskCancellationTokenCancellationToken

Cancellation token to cancel an operation.

codeReceiverICodeReceiver

The code receiver, if not specified a local server code receiver will be used.

Returns
TypeDescription
Task

Extension Method