PingOne Advanced Identity Cloud

Form fields

The forms editor provides standard fields to create your forms.

Custom fields

Create new forms using custom fields. Each field has a Key component allowing you to map the property to a specific schema element for the request type. You can find an example in Create a custom request type.

Text

The Text field accepts a single string. There is no character limit for this field.

Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Text field. The label appears within the field.

Description

Enter help text that describes the Text field. The text appears below the field.

Required

Click to make the field required.

Read Only

Click to make the field non-editable.

Provide Default Value

Click to enable and enter a default value.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1-12.

Offset

Enter a numeric value to offset from the left. Possible values are 0-11.

Use validation

Click to require validation on the Text field. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the Text field.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Textarea

The Textarea field accepts multiline strings. There is no limit for the number of lines for this field.

Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Textarea field. The label appears within the field.

Description

Enter help text that describes the Textarea field. The text appears below the field.

Required

Click to make the field required.

Read Only

Click to make the field non-editable.

Provide Default Value

Click to enable and enter a default value.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1-12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0-11.

Use validation

Click to require validation on the Textarea field. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the Textarea field.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Checkbox

The Checkbox field accepts a boolean value.

Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Checkbox field. The label appears next to the checkbox.

Description

Enter help text that describes the Checkbox field. The text appears below the checkbox.

Read Only

Click to make the field non-editable.

Provide Default Value

Click to enable and enter a default value.

Columns

Enter a numeric value for the number of columns to make the checkbox. Possible values are 1-12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0-11.

Use validation

Click to require validation on the checkbox. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the checkbox.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Select

The Select field accepts a single line from a list of enumerated values.

If you use a Select or Multiselect form field with an identity object (for example, user), you can assign that form to an approval task in any request workflow. When an end user views the request at the approval task in the approver’s inbox, they must have the required privileges to the identity object for the form input to function properly.

Learn more in Assign access request privileges to identities.
Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Select field. The label appears within the field.

Description

Enter help text that describes the Select field. The text appears below the field.

Required

Click to make the field required.

Read Only

Click to make the field non-editable.

Options

Click one of the following to populate the Select field entries: Enumerated or Object.

  • Click Enumerated to manually set enumerated values in the Select field.

    1. Click the icon.

    2. On the Add Option modal, do the following:

    3. Value: enter a value for the option field. For example, if you want to add a menu of administrators, go Identities > Manage. Search for an administrator to pull up their information. On the user’s page, click Raw JSON. Copy the user’s id, for example, 94080e61-f6a5-4bd0-bfc4-d26d6ae5c1b8 and enter the ID into the Value field.

    4. Label: enter a label for the option field. Enter the user’s name, for example, Cleo Patrascu.

    5. Click Selected by default to make the option a default enumerated value for the field.

    6. Click Add.

    7. Repeat the steps to add additional users.

  • Click Object to get a list of options taken from the API.

    1. Select one of the following object types:

      • User

      • Role

      • Organization

      • Application

      • Entitlement

      For example, if you want to create a Parent Organization select field, select Organization.

    2. Click Save.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1-12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0-11.

Use validation

Click to require validation on the Select field. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the Select field.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Multiselect

The Multiselect field accepts multiple strings from a list of enumerated values or freeform text input.

If you use a Select or Multiselect form field with an identity object (for example, user), you can assign that form to an approval task in any request workflow. When an end user views the request at the approval task in the approver’s inbox, they must have the required privileges to the identity object for the form input to function properly.

Learn more in Assign access request privileges to identities.
Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Multiselect field. The label appears within the field.

Description

Enter help text that describes the Multiselect field. The text appears below the field.

Required

Click to make the field required.

Read Only

Click to make the field non-editable.

Options

Click one of the following to populate the Select field entries: Enumerated or Object.

  • Click Enumerated to manually set enumerated values in the Select field.

    1. Click the icon.

    2. On the Add Option modal, do the following:

    3. Value: enter a value for the option field. For example, if you want to add a menu of administrators, go Identities > Manage. Search for an administrator to pull up their information. On the user’s page, click Raw JSON. Copy the user’s id, for example, 94080e61-f6a5-4bd0-bfc4-d26d6ae5c1b8 and enter the ID into the Value field.

    4. Label: enter a label for the option field. Enter the user’s name, for example, Cleo Patrascu.

    5. Click Selected by default to make the option a default enumerated value for the field.

    6. Click Add.

    7. Repeat the steps to add additional users.

  • Click Object to get a list of options taken from the API.

    1. Select one of the following object types:

      • User

      • Role

      • Organization

      • Application

      • Entitlement

      For example, if you want to create a Parent Organization select field, select Organization.

    2. Click Save.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1-12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0-11.

Use validation

Click to require validation on the Multiselect field. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the Multiselect field.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Date

The Date field accepts a single ISO-formatted string.

Details
Field Description

Key

Enter or select a property to write the field value to.

Label

Enter a label for the Date field. The label appears within the field.

Description

Enter help text that describes the Date field. The text appears below the field.

Required

Click to make the field required.

Read Only

Click to make the field non-editable.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1-12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0-11.

Use validation

Click to require validation on the Text field. If you click the box, enter the following:

  • Regex. Enter a regular expression to validate the Date field.

  • Error message. Enter an error message if validation fails.

Events

On Change Event: Enable On Change Event. Enter a JavaScript script to process the On Change event.

Utility

Enhance your forms using the utility fields, such as Form Text and Section. You can use the fields to add instructions to your form or organize the fields together.

Form Text

The Form Text field accepts multiple text strings. You can use this form field for any custom or generalized text, such as instructions.

Details
Field Description

Text to display

Enter custom form text. There is no character limit for this field.

Columns

Enter a numeric value for the number of columns to make the field. Possible values are 1 - 12.

Offset

Enter a numeric value to offset from the previous column. Possible values are 0 - 11.

Section

The Section field groups form fields together visually.

Details
Field Description

Key

Enter or select a property to write the field value to.

Header

Enter header text to display at the top of the section.

Footer

Enter footer text to display at the bottom of the section.