auth_browser library

Classes

AccessCredentials
OAuth2 Credentials.
AccessToken
An OAuth2 access token.
AuthClient
A authenticated HTTP client.
AuthEndpoints
The endpoints required for an OAuth 2.0 authorization code flow.
AutoRefreshingAuthClient
A auto-refreshing, authenticated HTTP client.
ClientId
Represents the client application's credentials.
GoogleAuthEndpoints
The endpoints required for an OAuth 2.0 authorization code flow with Google.
ServiceAccountCredentials
Represents credentials for a service account.

Enums

ResponseType
Available response types that can be requested when using the implicit browser login flow.

Extension Types

CodeResponse
The object passed as the parameter of your CodeClientCallbackFn.

Functions

authenticatedClient(Client baseClient, AccessCredentials credentials, {bool closeUnderlyingClient = false}) → AuthClient
Obtain a Client which automatically authenticates requests using credentials.
autoRefreshingClient(ClientId clientId, AccessCredentials credentials, Client baseClient, {AuthEndpoints authEndpoints = const GoogleAuthEndpoints()}) → AutoRefreshingAuthClient
Creates an AutoRefreshingAuthClient which automatically refreshes credentials before they expire.
clientViaApiKey(String apiKey, {Client? baseClient}) → Client
Obtains a Client which uses the given apiKey for making HTTP requests.
refreshCredentials(ClientId clientId, AccessCredentials credentials, Client client, {AuthEndpoints authEndpoints = const GoogleAuthEndpoints()}) → Future<AccessCredentials>
Obtains refreshed AccessCredentials for clientId and credentials.
requestAccessCredentials({required String clientId, required Iterable<String> scopes, String prompt = 'select_account', String? logLevel}) → Future<AccessCredentials>
Obtains AccessCredentials using the Google Identity Services token model.
requestAuthorizationCode({required String clientId, required Iterable<String> scopes, String? state, String? hint, String? hostedDomain, String? logLevel}) → Future<CodeResponse>
Obtains CodeResponse using the Google Identity Services code model.
revokeConsent(String accessTokenValue) → Future<void>
Revokes all of the scopes that the user granted to the app.

Exceptions / Errors

AccessDeniedException
Thrown if an attempt to make an authorized request failed.
AuthenticationException
Exception thrown when authentication fails.
ServerRequestFailedException
Thrown when a request to or the response from an authentication service is invalid.
UserConsentException
Thrown if user did not give their consent.