/entityType.rules

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

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

This endpoint includes the following methods:

  • POST


POST

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 Identity Cloud Capture domain; for example:

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

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

Example

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
       
      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.