auth library
This library has been deprecated. Use googleapis_auth instead.
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.
Functions
-
authenticatedClient(
Client baseClient, AccessCredentials credentials, {bool closeUnderlyingClient = false}) → AuthClient -
Obtain a
Clientwhich automatically authenticates requests usingcredentials. -
autoRefreshingClient(
ClientId clientId, AccessCredentials credentials, Client baseClient, {AuthEndpoints authEndpoints = const GoogleAuthEndpoints()}) → AutoRefreshingAuthClient -
Creates an AutoRefreshingAuthClient which automatically refreshes
credentialsbefore they expire. -
clientViaApiKey(
String apiKey, {Client? baseClient}) → Client -
Obtains a
Clientwhich uses the givenapiKeyfor making HTTP requests. -
refreshCredentials(
ClientId clientId, AccessCredentials credentials, Client client, {AuthEndpoints authEndpoints = const GoogleAuthEndpoints()}) → Future< AccessCredentials> -
Obtains refreshed AccessCredentials for
clientIdandcredentials.
Typedefs
- RefreshFailedException = ServerRequestFailedException
- No longer used. Replaced by ServerRequestFailedException.
Exceptions / Errors
- AccessDeniedException
- Thrown if an attempt to make an authorized request failed.
- ServerRequestFailedException
- Thrown when a request to or the response from an authentication service is invalid.
- UserConsentException
- Thrown if user did not give their consent.