Entity Types and Attributes

API endpoints for managing entity types (user profile databases) and the attributes that make up an entity type schema.


EndpointMethods

View Your Entity Types

/entityType.list
View all your entity types.
  • POST

View an Entity Type

/entityType
View detailed information for the specified entity type.
  • POST

Create an Entity Type

/entityType.create
Create an entity type.
  • POST

Create an Attribute

/entityType.addAttribute
Add an attribute to an entity type schema.
  • POST

Delete an Attribute

/entityType.removeAttribute
Delete an attribute from an entity type schema.
  • POST

Create a Validation Rule

/entityType.addRule
Add a validation data rule to en entity type schema. For example, you might add a rule that limits an attribute to no more than 20 characters.
  • POST

View Your Validation Rules

/entityType.rules
View validation rules for an entity type schema. Validation rules help determine the data that can and cannot be stored in an attribute.
  • POST

Delete a Validation Rule

/entityType.removeRule
Delete a validation rule from an entity type schema.
  • POST

Assign a Constraint to an Attribute

/entityType.setAttributeConstraints
Update the constraints assigned to an attribute. Constraints impose specific conditions on an attribute; for example, you mark an attribute as required meaning that a user cannot save their user profile unless that attribute has been set to a non-null value.
  • POST