Entity and EntityType APIs

API endpoints that enable you to manage users (entities) and user profile databases (entity types).

In addition to reference information for each endpoint, this section of the documentation also includes the following three articles:



EndpointMethods
 /entity     
View profile information for the specified user.
  • POST
/entity.bulkCreate
Create multiple user profiles with a single API call.
  • POST
/entity.count
Count the number of user profiles that meet the specified criteria (e.g., all the user profiles that have not been updated since June 1, 2020).
  • POST
/entity.create
Create a user profile..
  • POST
/entity.delete
Remove a user profile. Note that this operation cannot be undone.
  • POST
/entity.deleteAccess
Remove all access and refresh tokens for the specified user. If the happens, the user will need to reauthenticate before they can do such things as access their user profile.
  • POST
/entity.find
Search for user account (e.g., all the user who live in Canada).
  • POST
/entity.replace
Replace all the attribute values in a user profile with a new set of attribute values.
  • POST
/entity.update
Update specific attribute values in a user profile.
  • POST
/entityType
View detailed information for the specified entity type.
  • POST
/entityType.addAttribute
Add an attribute to an entity type schema.
  • POST
/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
/entityType.create
Create an entity type.
  • POST
/entityType.deleteAccessSchema
Remove an access chema. An access schema defines the subset of attributes to which a client has read or write access.
  • POST
/entityType.getAccessSchema
View the access schema for an entity type. An access schema defines the subset of attributes to which a client has read or write access.
  • POST

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

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

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

/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

/entityType.setAccessSchema
Update an access schema for an entity type. An access schema defines the subset of attributes to which a client has read or write access.
  • POST

/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