View your entity types

Return information about all your entity types (that is, all your user profile data stores).

API client permissions

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

owneraccess_issuerdirect_accessdirect_access_readlogin_client

Authentication

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

Base URL

The base URL for this operation is your 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.

Example: Return your entity types

Example request

This command returns all the entity types belonging to the application with the Capture domain https://my-app.janraincapture.com.

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg"\
  https://my-app.janraincapture.com/entityType.list

Example response

If your API call succeeds the response contains the names of all your entity types.

{
  "results": [
  "user"
  ],
  "stat": "ok"
}