Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration AuthenticationStepName

Names of the authentication steps.

Enumeration members

AUTHENTICATED

AUTHENTICATED: = "AUTHENTICATED"

This is an internal step used only by the library to detect authentication successful completion and cleanup data structures associated with authentication process, which are AuthenticationSession and FailedAuthenticationAttemptSession.

CHALLENGE_RESPONSE

CHALLENGE_RESPONSE: = "CHALLENGE_RESPONSE"

Challenge response verification step.
This step will be sent to client after nonce has been generated.

DISPATCH

DISPATCH: = "DISPATCH"

This is an internal step used only by the library to decide which authentication step is the next one.

ERROR

ERROR: = "ERROR"

This is an internal step used only by the library to detect authentication failure.

GENERATE_2FA_TOKEN

GENERATE_2FA_TOKEN: = "GENERATE_2FA_TOKEN"

This is an internal step used only by the library to generate 2fa token and send it to client via side channel.

GENERATE_CHALLENGE

GENERATE_CHALLENGE: = "GENERATE_CHALLENGE"

This is an internal step used only by the library to generate nonce needed by password-less authentication.

PASSWORD

PASSWORD: = "PASSWORD"

Password verification step. This is the first step in the password authentication method.
This step will be sent to client in case password verification failed so that it sends another valid password.

RECAPTCHA

RECAPTCHA: = "RECAPTCHA"

Recaptcha validation step.
This step will be sent to client when incorrect password has been submitted more than AuthenticationEngineThresholdsOptions.failedAuthAttemptsRecaptcha times.

TWO_FACTOR_AUTH_CHECK

TWO_FACTOR_AUTH_CHECK: = "TWO_FACTOR_AUTH_CHECK"

Two factor authentication code check.
This step will be sent to client after 2fa token has been generated.

UNKNOWN

UNKNOWN: = "UNKNOWN"

This is an internal step used only by the library to detect authentication process misconfigurations.