FedRAMP Solutions for Government User Guide

JSON field constraints

Submit your requests to define JSON field constraints through the service request form, accessible from the Support & Community page.

About this task

You can define a number of constraints for the fields included in JSON objects stored in values of a specified attribute type. For example, you can require that a field value is a specific data type, specify whether a field is required or optional, specify whether a field can have multiple values, or restrict values of string fields to a predefined set of values.

For additional information, refer to Managing JSON Attribute Values in the PingDirectory Server Administration Guide.

Steps

  1. Complete the following fields:

    • Subject: Enter a description of your request, including the action to be taken.

    • Environment Type: Specify the type of environment affected by this request.

    • Proposed Change Window: Specify the dates or times in which you want the work complete.

  2. From the Capability list, select PingDirectory service requests → JSON field constraints.

  3. In the Attribute type, provide the name or OID of the LDAP attribute type whose values will be subject to the associated field constraints. This attribute type must be defined in the server schema, and it must have a JSON object syntax.

  4. Optional: Select the Allow unnamed fields check box to indicate whether JSON objects stored as values of attributes with the associated attribute-type will be permitted to include fields for which there is no subordinate JSON field constraints definition. If unnamed fields are allowed, no constraints will be imposed on the values of those fields.

  5. In the JSON field field, specify the path to the target field as a string, with periods to separate levels of hierarchy. If a field name in the hierarchy includes a period, replace the period with a backslash.

  6. In the Value type field, select the expected data type for the target field:

    • String

    • Number

    • Object

    • Boolean

    • Integer

    • Any

  7. Optional: Select the Is required check box to indicate that the target field must be present.

  8. In the Is array field, specify whether the target field can be an array. If so, all of the elements of the array must be of the type specified in the Value type field.

    • Required

    • Optional

    • Prohibited

  9. Optional: Select the Allow null value check box if the target field can have a value of null as an alternative to the specified value type.

  10. Optional: Select the Allow empty object check box if the value of the target field is a JSON object (or an array of JSON objects) and empty objects are permitted.

  11. Optional: Select the Index values check box if the target field should be indexed.

  12. Select the appropriate description from the Business Priority list:

    • Change needed by deadline to avoid business impact

    • Change modifies existing functionality

    • Change adds new functionality

  13. Enter a description of your request in the Description field.

  14. If you are tracking your request within your organization, enter the tracking ID or ticket number associated with it in the Customer Tracking ID field.

  15. Click Save to submit your request.