okta-direct-auth/com.okta.directauth.api/DirectAuthenticationFlow/start

start

abstract suspend fun start(loginHint: String, primaryFactor: PrimaryFactor): DirectAuthenticationState

Starts the direct authentication flow with an initial factor.

This is the entry point for authenticating a user. Depending on the server's policy and the provided factor, the flow may complete in a single step or require additional steps, such as providing a secondary factor.

Return

the resulting DirectAuthenticationState — DirectAuthenticationState.Authenticated on immediate success, DirectAuthenticationState.MfaRequired or a com.okta.directauth.model.DirectAuthContinuation when more steps are needed, or a com.okta.directauth.model.DirectAuthenticationError on failure. Errors are returned as states, never thrown (cancellation excepted). Suspends until the server responds.

Parameters

loginHint

A hint to the authorization server about the user's identity, such as a username or email address.

primaryFactor

The initial authentication factor to use (e.g., a PrimaryFactor.Password).