/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

Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

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 -G -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode type_name=user\
    https://my-app.janraincapture.com/entityType.rules
       
      Running this command in Postman

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

Query Parameters

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