PingOne Advanced Identity Cloud

Form fields

The forms editor provides a set of standard fields to build your custom request and approval forms. You can add these fields to your forms to collect important information from users during the access request process or from approvers during the review process. This section describes the available fields and their configuration options.

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.

The references for each field are as follows:

Text

Use the Text field to add a single-line input for capturing short pieces of information, such as a username or a ticket number.

Details
Form Field Description

Select

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.

Layout

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

Use the Textarea field to add a multi-line input for capturing detailed information, such as a business justification or comments from an approver.

Details
Form Field Description

Textarea

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.

Layout

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.

Validation

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

Enter a script (JavaScript) to process the On Change event.

Checkbox

Use the Checkbox field to let users make a simple yes-or-no choice, such as agreeing to terms and conditions or opting into a mailing list.

Details
Form Field Description

[.label]#Checkbox

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.

Layout

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.

Events

On Change Event

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

Select

Use the Select field to let users choose a single option from a dropdown list, such as selecting a user, a role, or a predefined value.

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
Form Field Description

[.label]#Select

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

Enumerated or Object

Click one of the following:

  • 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.

  • Use Query Filter: Enter a query filter to filter select options.

Layout

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.

Events

On Change Event

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

Multiselect

Use the Multiselect field to let users choose one or more options from a list, such as selecting multiple permissions or assigning a user to several distribution groups.

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
Form Field Description

Multiselect

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

Enumerated or Object

Click one of the following:

  • 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.

  • Use Query Filter: Enter a query filter to filter multiselect options.

Layout

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.

Events

On Change Event

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

Date

Use the Date field to add a calendar picker, which lets users select a specific date for items like an access expiration date or an employment start date.

Details
Form Field Description

Date

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.

Layout

Columns

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

Events

On Change Event

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

Utility

Use utility fields like Form Text and Section to add general instructions and organize your form.

Form Text

Use the Form Text field to add instructional text or notes anywhere on your form, which helps guide users as they fill it out.

Details
Form Field Description

Form Text

Text to display

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

Layout

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

Use the Section field to organize your form by grouping related fields together under a common header, which improves readability and makes the form easier to navigate.

Details
Form Field Description

Section

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.