Endpoint URL: {identityDomain} /config/{appId} /entityTypes/{entityType}
Description
Returns information about a specific entity type (user profile data store).
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/{appI}/entityTypes/{entityType}/attributes/{attribute} endpoint.
Respects the API Client Allow List: Yes
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.
How to Create an Authentication String
Base URL
The base URL for this endpoint is your 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 htb8fuhxnf8e38jrzub3c7pfrr.
curl -G \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \ 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. |
If you encounter an error when calling this endpoint your error message will look similar to this:
{
"errors": "Authentication required."
}
