APIAuthProvider class abstract

Handles the retrieval of authentication tokens for third-party providers.

Users should subclass one of:

• OIDCAuthProvider: Handles OIDC authorization
• FunctionAuthProvider: Handles Custom Function authorization

For more information about the different authorization modes, see the docs.

Implementers

• FunctionAuthProvider
• OIDCAuthProvider

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → APIAuthorizationType<AmplifyAuthProvider>

The authorization type of this provider.

final

Methods

getLatestAuthToken() → Future<String?>

Returns the latest authorization token, or null if unavailable. If an Exception is thrown, it will be treated the same as a null token. However, Error objects will not be caught and must be handled by the developer.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited