DirectAuthenticationState

sealed interface DirectAuthenticationState

Represents the current state of a Direct Authentication flow.

This sealed interface defines the possible outcomes after an authentication step. The flow can either be complete, resulting in a Authenticated state, or require further user interaction, such as in an MfaRequired state or DirectAuthContinuation state.

In the case of a failure, the state will be an instance of DirectAuthenticationError. This can be an DirectAuthenticationError.HttpError for API-related issues (e.g., invalid credentials) or an DirectAuthenticationError.InternalError for unexpected client-side problems (e.g., network failures, response parsing errors).

Inheritors

Types

Link copied to clipboard

This state indicates that the user has been authenticated and tokens have been issued.

Link copied to clipboard

This state indicates that the authentication process is still pending and awaiting user action. Such as waiting for the user to complete an out-of-band (OOB) authentication step.

Link copied to clipboard

The authentication flow has been canceled

Link copied to clipboard

The initial state of the authentication flow, before any action has been taken.

Link copied to clipboard

The authentication flow requires an additional factor to complete.