PingOne

Adding user attributes

Use the Attributes page to add a user attribute to your environment.

Steps

  1. In the PingOne admin console, go to Directory > User Attributes.

  2. Click the Plus icon ().

  3. Select the type of attribute that you want to add:

    • Declared: Declared attributes are string attributes that applications can access through the PingOne API or the PingOne admin console. Declared attributes can be:

      • Unique

      • Multivalued

      • Enumerated

      • Validated (Regex)

    • JSON: JSON attributes are structured attributes that applications can access through the PingOne API or the PingOne admin console. Resources can use JSON attributes in their attribute mappings. You can use these attributes to pass complex information to applications through an access token. JSON attributes can be:

      • Multivalued

      • Validated (JSON Schema)

        The JSON is only checked to ensure that it’s valid and well-formed. No validation is performed against a particular schema.

  4. Click Next.

  5. Enter the following information:

    • Name: A unique identifier for the attribute.

    • Display Name: The name of the attribute as you want it to look in the user interface.

    • Description: A brief description of the attribute.

  6. Select the configuration options for the attribute:

    • Enforce unique values (declared attributes only): Require that attribute values be unique across the environment.

    • Allow multiple values: Allow the attribute to support multiple values:

      • When a multivalued attribute is mapped as part of an OpenID Connect (OIDC) or OAuth flow, the claim will be an array of values.

      • When a multivalued attribute is mapped as part of a SAML flow, the attribute will be a multivalued SAML attribute in the SAML assertion. Learn more in Mapping attributes.

      After you create an attribute that is multivalued, you can’t change it to single-valued.

    • Validation options (declared attributes only)

      Select an option in the list:

      • No Validation: No validation is needed.

      • Enumerated Values: Allows the attribute to have enumerated values.

        After you select this option, enter a value in the next field.

        To add multiple values, click + Add Value. Click X to remove a value.

      • Regex Validation: Requires that the attribute have a testable expression.

        1. After you select this option, enter the following information:

          • Expression: A regex expression.

          • Description: A brief description of the expression.

        2. Click Test Expression.

        3. In the Test Expression modal, enter values that match or don’t match the expression.

          To add multiple values, click + Add Value. Click X to remove a value.

        4. Click Save in the modal.

  7. Click Save in the details panel.

  8. To enable a user attribute, click the toggle to the right (blue).

    You can disable the user attribute by clicking the toggle to the left (gray) and clicking Confirm in the Confirm Disable modal.

Next steps

Map PingOne user attributes in your application, resource, identity provider, or provisioning connection. Learn more in Mapping attributes.