AuthMethodRegistrationRequiredState class
State indicating that authentication method registration is required.
- Extends
-
AuthMethodRegistrationState<AuthMethodRegistrationRequiredStateParameters>
Constructors
| Auth |
Creates a new instance of AuthFlowActionRequiredStateBase. |
Methods
| challenge |
Challenges an authentication method for registration. |
| get |
Gets the available authentication methods for registration. |
Constructor Details
AuthMethodRegistrationRequiredState(AuthMethodRegistrationRequiredStateParameters)
Creates a new instance of AuthFlowActionRequiredStateBase.
new AuthMethodRegistrationRequiredState(stateParameters: AuthMethodRegistrationRequiredStateParameters)Parameters
- stateParameters
-
AuthMethodRegistrationRequiredStateParameters
The parameters for the auth state.
Method Details
challengeAuthMethod(AuthMethodDetails)
Challenges an authentication method for registration.
function challengeAuthMethod(authMethodDetails: AuthMethodDetails): Promise<AuthMethodRegistrationChallengeMethodResult>Parameters
- authMethodDetails
- AuthMethodDetails
The authentication method details to challenge.
Returns
Promise that resolves to AuthMethodRegistrationChallengeMethodResult.
getAuthMethods()
Gets the available authentication methods for registration.
function getAuthMethods(): AuthenticationMethod[]Returns
Array of available authentication methods.