/entityType.rules

This lists the data validation rules that are currently set on a specific entityType. Each rule has a uuid identifier associated with it which is listed as well.

Refer to the Registration Error Codes section for details on error codes.

This endpoint includes the following methods:

  • GET


GET

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:

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

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Example


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

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Example Response


{
  "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"
}
       

Authorized Clients

owner

Security

  •  janrain-signed
  •  basic-auth

Query Parameters

Parameter Type Required Description
type_name string Yes Name of the entityType.