View the Attributes in an Entity Type

Endpoint URL: {identityDomain} /config/{appId} /entityTypes/{entityType} /attributes



Description

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


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

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg


Sample Request (curl)

This command returns the all attributes associated with the user entity type and the application htb8fuhxnf8e38jrzub3c7pfrr.


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

      Running this command in Postman


Responses

200 OK

If your call to this endpoint succeeds, you'll get back information for each attribute in the specified entity type. For more information about the attribute properties returned by the call, see Viewing Schema Information:


{
   "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes",
   "attributes": [
       {
           "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes/id",
           "required": false,
           "description": "simple identifier for this entity",
           "reverse-query": false,
           "ignore-update": null,
           "query": false,
           "unique": false,
           "case-sensitive": null,
           "name": "id",
           "locally-unique": false,
           "default": null,
           "primary-key": false,
           "length": null,
           "type": "id"
       },
      }
    ]
}
  


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