Get information about an entity type's attributes

get https://{hostname}/config/{app_id}/entityTypes/{entity_type}/attributes

Returns detailed information about each attribute in an entity type, including the attribute name and datatype. Attributes (roughly equivalent to database fields) represent individual bits of user information, such as a user’s first name or a user’s email address.

Responses

Response body

object

_self

string

Configuration URL for the entity type.

required

boolean

Requires a non-null value be provided for an attribute. For example, if displayName is set to required that means that the user has to enter a display name. Processing can't continue until a value has been entered for the displayName attribute.

description

string

Description of an attribute and its use.

reverse-query

string

Indexes the attribute to enable leading wildcard searches, such as *@gmail.com, where the wildcard character is the first character in the target search value.

ignore-update

boolean

Allows data to be written just once to an attribute. For example, when you create a new user profile the date and time are recorded in the created attribute. After that initial update the value of the createdattribute can't be changed.

query

string

Indexes the attribute for improved search performance and wildcard searching. Console can only search for indexed attributes.

unique

string

Enforces uniqueness on an attribute value across an entity type. For example, if email is marked as a unique attribute, then only one user in that entity type can have the email address karim.nafir@mail.com.

case-sensitive

string

Enforces case-sensitivity when checking uniqueness on an attribute value when searching in Console or by using the /entity.find API operation.

name

string

Name of the attribute. When naming attributes, keep in mind that attribute names are case-sensitive and that you need to specify the full attribute path when adding a new plural or object attribute. For example, to add an attribute named county to the primaryAddress object you need to use the format `primaryAddress.county.

locally-unique

boolean

Enforces uniqueness on a plural attribute within an individual user record. For example, suppose a user has a client with a clientId of hb7ntpcgqf7c5fk3jrehq8wpatn23bvd. Because clientId is locally unique, adding another client to the user profile that has the client ID hb7ntpcgqf7c5fk3jrehq8wpatn23bvd fails. However, other users in the entity type can have a client with that client ID.

default

string

Assigns a default value to an attribute if no value is submitted during record creation. For example, you might assign the value US as the default value for the primaryAddress.country property. If a user fails to enter their country of residence when they register then primaryAddress.country is automatically be set to US.

primary-key

string

Allows a plural entry to be targeted in user profile update operation by using the value stored in the attribute as a unique identifier.

length

string

Enforces a maximum number of characters in the string to a value less than or equal to the supplied integer value. For example, if the length is set to 7 then apple is an acceptable value but pomegranate isn't an acceptable value and is rejected.

type

string

Data type of the attribute.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/config/app_id/entityTypes/entity_type/attributes \
3
     --header 'accept: application/json'


xxxxxxxxxx
21
 
1
{
2
  "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes",
3
  "attributes": [
4
    {
5
      "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/entityTypes/user/attributes/id",
6
      "required": false,
7
      "description": "simple identifier for this entity",
8
      "reverse-query": false,
9
      "ignore-update": null,
10
      "query": false,
11
      "unique": false,
12
      "case-sensitive": null,
13
      "name": "id",
14
      "locally-unique": false,
15
      "default": null,
16
      "primary-key": false,
17
      "length": null,
18
      "type": "id"
19
    }
20
  ]
21
}

200Message block containing messages and metadata.

400Not valid.

401Not authorized.

404Not found.