/entity.bulkCreate

Creates multiple user profiles with a single API call. 

This endpoint includes the following methods:

  • POST

POST

Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Identity Cloud Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:

Examples

Example request

This command creates three new user accounts, specifying the following attribute values for each account:

  • familyName
  • givenName
  • email
  • statuses

Note that the statuses attribute is a plural attribute, and contains two child attributes: status and statusCreated.


curl -X POST \
  -H "Authorization: c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user\
  --data-urlencode all_attributes='[{"familyName":"Jones","givenName":"Abe","email":"jonesa@example.com","statuses":[{"status":"active",statusCreated":"2015-12-15T07:36:25Z"}]},{"givenName":"Jackson","familyName":"Gordon","email":"gjack@test.com","statuses":[{"status":"inactive","statusCreated":"2015-10-12T04:00:00Z"}]},{"givenName":"Sally","familyName": "Smith","email":"ssmith@myorg.org"}]' \
  https://my-app.janraincapture.com/entity.bulkCreate
          
      Running this command in Postman

Example Results


{
  "uuid_results": [
   "efd7fe4e-c0a2-4b80-876e-1d06df393579",
   "3314d744-09a9-4264-a17f-402d3e4824e7",
   "639dbbbc-6cac-4054-83be-92e08ced155f"
 ],
  "results": [
    11393,
    11395,
    11397
  ],
  "stat": "ok"
}
          

Authorized Clients

  • owner 
  • direct_access

Query Parameters

Parameter Type Required Description
type_name string Yes entityType of the entity.
 
all_attributes string Yes Attribute names and values (formatted as a JSON object) for the entity. This argument is parsed as one entity.: if any part of the argument fails to parse, the entire request will be rejected.