/config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}

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


GET

Returns information about the specified attribute.

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

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


{
   "errors": "Authentication required."
}