View an entity type

Returns detailed information about the specified entity type.

API client permissions

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

owner	access_issuer	direct_access	direct_access_read	login_client
✓	✓	✓	✓	✓

Authentication

This operation supports Basic authentication (recommended) as well as janrain-oauth and janrain-signed authentication. See Get started for more information.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

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

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Examples

Example request: Return an entity type

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

Example response

If your API call succeeds the response contains the requested schema:

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

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.

Parameter	Type	Required	Description
type_name	string	✓	Name of the entity type.

Updated over 1 year ago