View your validation rules

Returns all the data validation rules configured for the specified entity type.

Refer to the Registration error codes page for details on error codes.

API client permissions

The following table indicates the API clients that can and can't be used to call this endpoint:

Authentication

This operation supports both Basic authentication (recommended) and janrain-signed authentication. See Get started for more information.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Example: Return validation rules

This command returns all the rules assigned to the user entity type.

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg" \
  --data-urlencode type_name=user \
  https://my-app.janraincapture.com/entityType.rules

Example response

If your API call succeeds the response contains information about the validation rules assigned to the specified entity type:

{
  "results": [
    {
      "attributes": [
        "/givenName"
      ],
      "description": "This is a rule to accept only English letters and have a maximum Length of 25",
      "uuid": "656670ad-ae24-43a2-8ab1-a8b070c19bb8",
      "definition": {
        "and": [
          {
            "match-all": "[a-zA-Z]*"
          },
          {
          "max-length": 25
          }
        ]
      }
    }
  ],
  "stat": "ok"
}

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.