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:


Entities and User Profiles



EndpointMethods

 View a User Profile

/entity     
View profile information for the specified user.
  • POST

Search for User Profiles

/entity.find
Search for user account (e.g., all the user who live in Canada).
  • POST

Count User Profiles

/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

Modify a User Profile

/entity.update
Update specific attribute values in a user profile.
  • POST

Replace a User Profile

/entity.replace
Replace all the attribute values in a user profile with a new set of attribute values.
  • POST

Create a User Profile

/entity.create

Create a user profile.
  • POST

Create Multiple User Profiles

/entity.bulkCreate
Create multiple user profiles with a single API call.
  • POST

Delete a User Profile

/entity.delete
Remove a user profile. Note that this operation cannot be undone.
  • POST

Invalidate a User Session

/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 Types and Attributes

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



Access Schemas

EndpointMethods

View Your Access Schemas

/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

Create an Access Schema

/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

Delete an Access Schema

/entityType.deleteAccessSchema
Remove an access schema. An access schema defines the subset of attributes to which a client has read or write access.
  • POST