ChallengeStepHandler <ResponseType>

Performs a server challenge request that returns some DirectAuthenticationFlow.Status.

Some flow steps need to perform some initial request that results in some return status, but does not intend to directly exchange a Token. For example, when a WebAuthn authentication challenge needs to be produced, or when an SMS verification code needs to be sent.

Implements

• StepHandler

Index

Constructors

• constructor

Properties

• flow
• request
• statusBlock

Methods

• process

Constructors

constructor

• new ChallengeStepHandler<ResponseType>(flow: DirectAuthenticationFlow, request: Request<ResponseType>, statusBlock: ChallengeStepStatusBlock<ResponseType>): ChallengeStepHandler<ResponseType>

• Type parameters

  • ResponseType

  Parameters

  • flow: DirectAuthenticationFlow

  • request: Request<ResponseType>

  • statusBlock: ChallengeStepStatusBlock<ResponseType>

  Returns ChallengeStepHandler<ResponseType>

Properties

readonlyflow

flow: DirectAuthenticationFlow

Implementation of StepHandler.flow

Reference to the flow this step handler is invoked from.

readonlyrequest

request: Request<ResponseType>

readonlystatusBlock

statusBlock: ChallengeStepStatusBlock<ResponseType>

Methods

process

• process(): Promise<Status>

• Implementation of StepHandler.process

  Processes the current step, returning the given status when the step has completed, or throws the appropriate error.

  @throws

  Error indicating a problem that occurred within this step.

  ---

  Returns Promise<Status>

  Status of the resulting operation.