/entityType.setAttributeConstraints

Sets the list of constraints for an attribute. The available constraints are: required, unique, locally-unique, alphabetic, alphanumeric, unicode-letters, unicode-printable, and email-address.

Warning. This is not an additive operation, you must pass in the entire set of constraints.

Removing Constraints

Instead of removing a constraint, use this endpoint to overwrite the existing constraint with a new constraint. For example, suppose an attribute currently has the unique and required constraints, and you want to drop the required constraint. In that case, you would pass in constraints=["unique"]. Note that the constraints argument must be a valid JSON array; however you can pass in an empty array, which is the equivalent of no constraints at all.

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

This command includes the following methods:

POST

POST

API Client Permissions

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

owner	access_issuer	direct_access	direct_read_access	login_client
Yes	No	No	No	No

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:

Examples

Example Request

This command assigns the required constraint to the givenName attribute in the user entity type. Among other things, this means that users must specify their given name when registering or when editing their user profile.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg"\
  --data-urlencode type_name=user \
  --data-urlencode attribute_name=givenName \
  --data-urlencode constraints=["required"] \
  https://my-app.janraincapture.com/entityType.setAttributeConstraints

Running this command in Postman

Example Response


{
  "schema": {
    "attr_defs": [
      {
        "name": "id",
        "description": "simple identifier for this entity",
        "type": "id"
      },
      {
        "name": "uuid",
        "description": "globally unique identifier for this entity",
        "type": "uuid"
      },
      {
        "name": "created",
        "description": "when this entity was created",
        "type": "dateTime"
      },
      {
        "name": "lastUpdated",
        "description": "when this entity was last updated",
        "type": "dateTime"
      },
      {
      "length": null,
        "name": "aboutMe",
        "type": "string",
        "case-sensitive": false
      },
      {
        "length": 1000,
        "constraints": [
          "required"
        ],
        "name": "givenName",
        "type": "string",
        "case-sensitive": false
      },
      {
        "name": "lastLogin",
        "type": "dateTime"
      }
    ],
    "name": "user"
  },
  "stat": "ok"
}

Query Parameters

Parameter	Type	Required	Description
type_name	string	Yes	Name of the entityType.
attribute_name	string	Yes	Case-sensitive name of the attribute to be modified.
constraints	string	Yes	JSON-formatted list of constraints for the attribute.

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

POST

Running this Command in Postman

How to Create an Authentication String

Rate this Article