AuthenticationFlow <Delegate>

An interface defining a type of authentication flow.

OAuth2 supports a variety of authentication flows, each with its own capabilities, configuration, and limitations. To normalize these differences, the AuthenticationFlow protocol is used to represent the common capabilities provided by all flows.

For more information please see the larger discussion on Authentication Flows

Hierarchy

• UsesDelegateCollection<Delegate>
  • AuthenticationFlow

Implemented by

• AuthorizationCodeFlow
• DeviceAuthorizationFlow
• DirectAuthenticationFlow
• InteractionCodeFlow
• JWTAuthorizationFlow
• ResourceOwnerFlow
• TokenExchangeFlow

Index

Properties

• client
• delegateCollection
• isAuthenticating

Methods

• add
• remove
• reset

Properties

readonlyclient

client: OAuth2Client

delegateCollection

delegateCollection: DelegateCollection<Delegate>

Inherited from UsesDelegateCollection.delegateCollection

The collection of delegates this flow notifies for key authentication events.

readonlyisAuthenticating

isAuthenticating: boolean

Indicates if this flow is currently authenticating.

Methods

add

• add(delegate: Delegate): void

• Inherited from UsesDelegateCollection.add

  Adds the given argument as a delegate.

  ---

  Parameters

  • delegate: Delegate

    Delegate to add to the collection.

  Returns void

remove

• remove(delegate: Delegate): void

• Inherited from UsesDelegateCollection.remove

  Removes the given argument from the collection of delegates.

  ---

  Parameters

  • delegate: Delegate

    Delegate to remove from the collection.

  Returns void

reset

• reset(): void

• Resets the authentication session.

  ---

  Returns void