This step type prompts the end user to submit a registration form.

Step properties used with flow definitions

Configuration schema property Description
form.id A string that specifies the form ID for the registration form to submit to the form manager service. Only forms of type REGISTRATION may be referenced by this form ID. This is a required property.
Input property Description
formData An object that specifies the context data used to render the form and pre-fill fields. Properties are derived from the selected form and retrieved from the form manager service at configuration time.

The following properties are returned for the SUBMITTED result.

Output property Description
form.id A string that specifies the form ID.
form.name A string that specifies the form name.
formData An object that encapsulates the submitted form data. Properties are derived from the selected form and retrieved from the form manager service at configuration time.

Step properties used with flow executions

Flow state Description
FORM_REQUIRED A flow status that requires the user to submit a registration form.
Flow state response schema property Description
form.id A string that specifies the registration form ID.
formData An object that specifies the context data passed into the step as input that is used to pre-fill the registration form.
Embedded resources Description
passwordPolicy An object that specifies the password policy information. If the form includes any password fields, the environment’s default password policy is included.
Links Description
form.submit The link to initiate the form submit action. The action must specify application/vnd.pingidentity.form.submit+json as the custom content type.
Parameters Description
{{formDataProperties}} The submitted form data.