Entities and User Profiles

API endpoints for managing user accounts 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