/config/{appId}/entityTypes/ {entityType}/attributes/ {attribute}

Returns detailed information about a specified attribute, including the attribute name and datatype. Attributes are the individual fields that make up an entity type schema.

This endpoint includes the following methods:

GET

Returns information about the specified attribute.

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	No	No	No	No

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:

Sample Request (curl)

This command returns detailed information about the displayName attribute found in the user entity type.


curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg'\ 
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes/displayName

Running this command in Postman

Responses

200 OK

If your call to this endpoint succeeds, you'll get back information for the specified attribute:


{
   "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes/displayName",
   "required": false
   "description": "The name of this Contact, suitable for display to end-users.",
   "reverse-query": false,
    "ignore-update": null,
   "query": true,
    "unique": false,
   "case-sensitive": false,
   "name": "displayName",
   "locally-unique": false,   
    "default": null,
   "primary-key": false,
   "length": 1000,
    "type": "string"
}

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

/config/{appId}/entityTypes/ {entityType}/attributes/ {attribute}

GET

Running this Command in Postman

How to Create an Authentication String

Rate this Article