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 articles:
- Entity API Overview
- Entity API Security Schemes
- API Client Permissions: Entity and Entity Type API
- Managing Users Profiles by Using janrain-oauth Authentication
Entities and User Profiles
| Endpoint | Methods |
|---|---|
View a User Profile/entityView profile information for the specified user. |
|
Search for User Profiles/entity.findSearch for user account (e.g., all the user who live in Canada). |
|
Count User Profiles/entity.countCount 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). |
|
Modify a User Profile/entity.updateUpdate specific attribute values in a user profile. |
|
Replace a User Profile/entity.replaceReplace all the attribute values in a user profile with a new set of attribute values. |
|
Create a User Profile/entity.createCreate a user profile. |
|
Create Multiple User Profiles/entity.bulkCreateCreate multiple user profiles with a single API call. |
|
Delete a User Profile/entity.deleteRemove a user profile. Note that this operation cannot be undone. |
|
Invalidate a User Session/entity.deleteAccessRemove 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. |
|
Entity Types and Attributes
| Endpoint | Methods |
|---|---|
View Your Entity Types/entityType.listView all your entity types. |
|
View an Entity Type/entityTypeView detailed information for the specified entity type. |
|
Create an Entity Type/entityType.createCreate an entity type. |
|
Create an Attribute/entityType.addAttributeAdd an attribute to an entity type schema. |
|
Delete an Attribute/entityType.removeAttributeDelete an attribute from an entity type schema. |
|
Create a Validation Rule/entityType.addRuleAdd 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. |
|
View Your Validation Rules/entityType.rulesView validation rules for an entity type schema. Validation rules help determine the data that can and cannot be stored in an attribute. |
|
Delete a Validation Rule/entityType.removeRuleDelete a validation rule from an entity type schema. |
|
Assign a Constraint to an Attribute/entityType.setAttributeConstraintsUpdate 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. |
|
Access Schemas
| Endpoint | Methods |
|---|---|
View Your Access Schemas/entityType.getAccessSchemaView the access schema for an entity type. An access schema defines the subset of attributes to which a client has read or write access. |
|
Create an Access Schema/entityType.setAccessSchemaUpdate an access schema for an entity type. An access schema defines the subset of attributes to which a client has read or write access. |
|
Delete an Access Schema/entityType.deleteAccessSchemaRemove an access schema. An access schema defines the subset of attributes to which a client has read or write access. |
|