/config/{app_id}/entityTypes

Entity types refer to the schemas that underlie user profile databases; these schemas, in turn, are made up of attributes (for the most part, attributes are equivalent to the fields in a database table). In the Janrain Console, you can find the names of all your entity types by expanding Manage Schemas:

The /config/{app_id}/entityTypes endpoint returns information about the entity types associated with an application. In addition to that, you can use the POST method to create a new entity type.

This endpoint includes the following methods:

  • GET


GET

Returns information about all the entity types associated with an application.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg

Sample Request (curl)

This command returns information about all the entity types associated with the application htb8fuhxnf8e38jrzub3c7pfrr.


curl -X GET \
    https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes \
    -H 'Authorization: Basic aW1fYV...NfbXk='

      Running this command in Postman

Responses

200 OK

If your API call succeeds, you'll get back information about each of your entity types:


[
    {
       "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/Test",
       "name": "Test"
    },
    {
       "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user",
       "name": "user"
    }
]

Error Codes

The following table includes information about some of the error codes that you could encounter when calling this endpoint.

Error Code

Description

401/403

Error Message: Authentication required.

You either failed to provide credentials or provided invalid credentials. This endpoint requires Basic authentication.

404

Error Message: Application ID not found.

You did not provide a valid application ID.

If you encounter an error when calling this endpoint that error message will look similar to this:


{
   "errors": "Authentication required."
}