Returns detailed information about the specified entity type.
This endpoint includes the following entity types:
- 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 | 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-
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. |