/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

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:

Sample Request (curl)

This command returns information about the user entity type associated with the application that has the application ID htb8fuhxnf8e38jrzub3c7pfrr:


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

Running this command in Postman

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.

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.

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 your error message will look similar to this:


{
   "errors": "Authentication required."
}

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

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

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

the right to read user profile information) needed to complete the API call.

GET

Running this Command in Postman

How to Create an Authentication String