DirectAuthenticationFlow

An authentication flow that implements the Okta Direct Authentication API.

This enables developers to build native sign-in workflows into their applications, while leveraging MFA to securely authenticate users, without the need to present a browser. Furthermore, this enables passwordless authentication scenarios by giving developers the power to choose which primary and secondary authentication factors to use when challenging a user for their credentials.

Implements

• AuthenticationFlow<DirectAuthenticationFlowDelegate>

Index

Constructors

• constructor

Properties

• client
• delegateCollection
• isAuthenticating
• supportedGrantTypes

Methods

• add
• remove
• reset
• resume
• start

Constructors

constructor

• new DirectAuthenticationFlow(): DirectAuthenticationFlow
• new DirectAuthenticationFlow(configFile: String): DirectAuthenticationFlow
• new DirectAuthenticationFlow(issuer: URL, clientId: String, scopes: String, supportedGrants: [GrantType]): DirectAuthenticationFlow
• new DirectAuthenticationFlow(client: OAuth2Client, supportedGrants: [GrantType]): DirectAuthenticationFlow

• Default constructor that loads the default Okta.plist or Okta.json configuration.

  Not all languages or environments support the concept of a configuration file format.

  In these environments, this constructor can be omitted.

  ---

  Returns DirectAuthenticationFlow

Properties

readonlyclient

client: OAuth2Client

Implementation of AuthenticationFlow.client

The OAuth2Client this authentication flow will use.

delegateCollection

delegateCollection: DelegateCollection<DirectAuthenticationFlowDelegate>

Implementation of AuthenticationFlow.delegateCollection

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

readonlyisAuthenticating

isAuthenticating: boolean

Implementation of AuthenticationFlow.isAuthenticating

Indicates whether or not this flow is currently in the process of authenticating a user.

readonlysupportedGrantTypes

supportedGrantTypes: [GrantType]

The list of grant types the application supports.

Methods

add

• add(delegate: DirectAuthenticationFlowDelegate): void

• Implementation of AuthenticationFlow.add

  Adds the given argument as a delegate.

  ---

  Parameters

  • delegate: DirectAuthenticationFlowDelegate

    Delegate to add to the collection.

  Returns void

remove

• remove(delegate: DirectAuthenticationFlowDelegate): void

• Implementation of AuthenticationFlow.remove

  Removes the given argument from the collection of delegates.

  ---

  Parameters

  • delegate: DirectAuthenticationFlowDelegate

    Delegate to remove from the collection.

  Returns void

reset

• reset(): void

• Implementation of AuthenticationFlow.reset

  Resets the authentication session.

  ---

  Returns void

resume

• resume(from: Status, withFactor: SecondaryFactor): Promise<Status>
• resume(from: Status, withFactor: ContinuationFactor): Promise<Status>

• Resumes authentication when an additional (secondary) factor is required to verify the user.

  This function should be used when a MFA required status response is received.

  ---

  Parameters

  • from: Status

    The previous status returned from the server.

  • withFactor: SecondaryFactor

    The secondary factor to use when authenticating the user.

  Returns Promise<Status>

start

• start(loginHint: String, withFactor: PrimaryFactor, intent?: Intent): Promise<Status>

• Start user authentication, with the given username login hint and primary factor.

  ---

  Parameters

  • loginHint: String

    The login hint, or username, to authenticate.

  • withFactor: PrimaryFactor

    The primary factor to use when authenticating the user.

  • intent: Intent = Intent.signIn

    The intentino of the user's authentication operation. Default: signIn.

  Returns Promise<Status>