← Back to plugin index

FIDO Registration Step

Description

Step to register a new credential on a FIDO authenticator.

Type name
FidoRegistrationStep
Class
com.airlock.iam.flow.shared.application.configuration.step.FidoRegistrationStepConfig
May be used by
License-Tags
FIDO
Properties
FIDO Settings (fidoSettings)
Description
Settings for FIDO.
Attributes
Plugin-Link
Mandatory
Assignable plugins
On Failure Gotos (onFailureGotos)
Description

If the step fails (no retry) and a goto target for the error code is defined here, the flow does not fail and instead a "goto" to the specified target step is executed. Note that even when the "goto" is executed, any error codes that are considered a failed factor attempt will still increment the "failed attempts" counter, and may lead to the user being locked. Therefore, this may still result in a failed flow.

This step can return the following error codes:

  • FIDO_REGISTRATION_FAILED: The FIDO registration failed for unspecified reasons (either in the browser/client or during server-side verification).
  • FIDO_REGISTRATION_ATTESTATION_INVALID: The attestation object supplied by the FIDO authenticator could not be successfully verified.
  • FIDO_REGISTRATION_TIMEOUT: The response from the browser/client has timed out.
  • FIDO_REGISTRATION_ABORTED: The registration has been aborted in the browser/client.
  • FIDO_REGISTRATION_NOT_ALLOWED: The browser/client did not allow registration with the given parameters.
  • FIDO_REGISTRATION_NOT_SUPPORTED: The browser/authenticator does not support the configured FIDO parameters (e.g. the requested key algorithms).
  • FIDO_WEB_AUTHN_NOT_AVAILABLE: The client/browser is not capable of performing WebAuthn/FIDO registration.

Attributes
Plugin-Map
Optional
Assignable plugins
Interactive Goto Targets (interactiveGotoTargets)
Description
Manually selectable Goto targets. These are steps to which the user can chose to jump when this is the current flow step.
Attributes
Plugin-List
Optional
Assignable plugins
Dynamic Step Activations (dynamicStepActivations)
Description
Steps that can be dynamically activated while in this step.
Attributes
Plugin-List
Optional
Assignable plugins
Skip Condition (skipCondition)
Description

If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.

Attributes
Plugin-Link
Optional
Assignable plugins
Pre Condition (preCondition)
Description
This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.
Attributes
Plugin-Link
Optional
Assignable plugins
Requires Activation (requiresActivation)
Description
If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).
Attributes
Boolean
Optional
Default value
false
Tags On Success (tagsOnSuccess)
Description
This step grants these tags if it completes successfully.
Attributes
Plugin-List
Optional
Assignable plugins
Step ID (stepId)
Description
ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.
Attributes
Plugin-Link
Optional
Assignable plugins
Custom Response Attributes (customResponseAttributes)
Description

A list of custom attributes that are returned in the REST response in addition to the standard attributes the step already returns. The custom attributes defined here are only returned if the step result does not lead to an error response.

Custom attributes are added to the response when a step is initialized and when actions are executed on the step. They will therefore be available in the response leading to this step, and in any responses from endpoints specific to this step. For non-interactive steps, custom attributes are accumulated and added to the response leading to the next interactive step.

Custom attributes are not returned for 'retrieve' endpoints.

Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)

type: FidoRegistrationStep
id: FidoRegistrationStep-xxxxxx
displayName: 
comment: 
properties:
  customFailureResponseAttributes:
  customResponseAttributes:
  dynamicStepActivations:
  fidoSettings:
  interactiveGotoTargets:
  onFailureGotos:
  preCondition:
  requiresActivation: false
  skipCondition:
  stepId:
  tagsOnSuccess: