View an Entity Type

Endpoint URL: {registrationDomain} /entityType

Description

Returns detailed information about the specified entity type.

Respects the API Client Allow List: Yes

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

Authentication

This endpoint supports Basic authentication (recommended) as well as janrain-oauth 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 returns the schema for the user entity type.

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

Running this command in Postman

Example Response

{
  "schema": {
    "attr_defs": [
      {
        "name": "id",
        "type": "id"
      },
      {
        "name": "lastUpdated",
        "type": "version"
      },
      {
        "name": "birthday",
        "type": "string",
        "length": 10
      },
      {
        "name": "zipcode",
        "type": "string",
        "length": 5
      },
      {
        "name": "name",
        "type": "object",
        "attr_defs": [
          {
            "name": "id",
            "type": "id"
          },
          {
            "name": "firstName",
            "type": "string",
            "length": 128
          },
          {
            "name": "lastName",
            "type": "string",
            "length": 128
          }
        ]
      }
    ],
    "name": "user"
  },
  "stat": "ok"
}

Query Parameters

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

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.

Endpoint URL: {registrationDomain} /entityType

Description

Respects the API Client Allow List: Yes

API Client Permissions

Authentication

Base URL

Examples

Query Parameters

Running this Command in Postman

How to Create an Authentication String

Rate this Article