Return a JSON representation of an existing entityType.
This endpoint includes the following entity types:
- GET
GET
Base URL
The base URL for this endpoint is your Janrain Capture domain; for example:
https://educationcenter.us-
Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:
Examples
Example Request
Return the JSON representation of the schema definition for the entityType 'user'.
curl -H "Authorization: Basic aW1fYV...NfbXk="\
--data-urlencode type_name=user\
https://my-app.janraincapture.com/entityType
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"
}
Authorized Clients
- owner
- login_client
- direct_read_access
- direct_access
- access_issuer
Security
- janrain-signed
- basic-auth
- janrain-oauth
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| type_name | string | Yes | Name of the entityType. |