/config/{app_id}/entityTypes/{entity_type}

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). 

The /config/{app_id}/entityTypes/{entity_type} endpoint provides a way to return information about a specific entity type associated with an application. 

Note. You cannot use this endpoint to modify an entity type; that is, this endpoint cannot add, delete, or modify the attributes that make up an entity type. To work with attributes use the /config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name} endpoint.

This endpoint includes the following methods:

• GET

GET

Description

Returns information about the specified entity type.

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 the user entity type associated with the application that has the application ID htb8fuhxnf8e38jrzub3c7pfrr:

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

Responses

200 OK

If your API call succeeds you will get back information about the specified entity type. The information consists of two relative URLS:

• _self, the URL of the entity type itself.
• _attributes, the URL used for managing the attributes associated with the entity type.

For example:

{
   "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/test",
   "_attributes": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/test/attributes"
}

Error Codes

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

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

{
   "errors": "Authentication required."
}

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))