Entity and EntityType API
Managing users (entities) and user profile databases (entity types)
The Entity endpoints are used to modify Identity Cloud entities (user profiles), while the entityType endpoints help you manage the schemas and databases that store those user profiles.
An introduction to the Entity and entityType API can be found in the following articles:
The actual API endpoints are listed below.
| /entity Returns the entity attributes (user profile values) for the specified user. |
GET |
| /entity.bulkCreate Creates multiple user profiles in the specified entityType (user database). |
POST |
| /entity.count Returns the number of records in an entityType that meet the specified criteria (for example, the number of users who specified male as their preferred gender). |
GET |
| /entity.create Creates a new user profile. |
POST |
| /entity.delete Deletes the specified user profile. |
POST |
| /entity.deleteAccess Invalidates the current session for the specified user. This is done by permanently removing all access tokens, refresh tokens, and refresh secrets associated with the user account. This forces the user to log on again before he or she can do anything else. |
POST |
| /entity.find Returns information for all the user accounts that meet the specified criteria (for example, all the users who live in Portland, OR), |
GET |
| /entity.replace Replaces attribute values in a user profile. Note that attribute values not specified in your call will be set to NULL. For example, if you do not specify the user's phone number the existing phone number will be deleted and the phone number attribute set to NULL. |
POST |
| /entity.update Updates the specified value (or values) in a user profile (e.g., changing a user's phone number or street address). Note that attributes not specified in your call will be left as-is; only the attributes specified in the call are modified. |
POST |
| /entityType Returns information about the specified entityType (user database). |
GET |
| /entityType.addAttribute Adds a new attribute (database field) to an entityType. |
POST |
| /entityType.addRule Adds a new data validation rule to an entityType. |
POST |
| /entityType.create Creates a new entityType. |
POST |
| /entityType.deleteAccessSchema Deletes the specified access schemas. Access schemas determine the entityType attributes that a property (API client) has read or write access to. If the access schema is deleted, the specified client will have full read or write access to all the attributes in the entityType. |
POST |
| /entityType.getAccessSchema Retrieves the specified access schema. Access schemas determine the entityType attributes than a property (API client) has read or write access to. |
GET |
| /entityType.list Returns information about all the available entityTypes. |
GET |
| /entityType.removeAttribute Removes an attribute (database field) from an entityType. |
POST |
| /entityType.removeRule Removes the specified validation rule from an entityType. |
POST |
| /entityType.rules Returns all the validation rules associated with an entityType. |
GET |
| /entityType.setAccessSchema Assigns a new access schema to a property (API) client. Access schemas determine the entityType attributes that a property has read or write access to. Each API client can have one read access schema and one write access schema per entityType. |
POST |
| /entityType.setAttributeConstraints Assigns one or more constraints to an attribute. For example, if all users must have a phone number and if those phone numbers must be unique, you would assign the phone number attribute the required and the unique restraints. |
POST |