/entity.create

Creates a new user profile. Note that, because of database replication requirements, it sometimes takes a few minutes for the newly-created user profile to be available to the entity.find and entity.count endpoints (the latter when using filters). See the include_record parameter for more information.

Refer to the Registration Error Codes section for details on error codes.

This endpoint uses 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 a new user account, specifying the following attribute values for the 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: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user\
  --data-urlencode attributes='{"givenName":"Matt","familyName":"Parker","email":"parkerm@example.com","statuses":[{"status":"active","statusCreated":"2019-10-15T07:36:25Z"}]}' \
  https://my-app.janraincapture.com/entity.create
   

      Running this command in Postman


Example Response


{
  "id": 11649,
  "uuid": "02b0c68d-7d7a-49d8-a88d-022585b0f877",
  "stat": "ok"
}
   

Example Error Response


{
  "argument_name": "attributes",
  "request_id": "geup8cd3gvcvjjnc",
  "code": 200,
  "error_description": "attributes was not valid for the following
    reason: the JSON isnot syntactically valid",
  "error": "invalid_argument",
  "stat": "error"
}
   

Authorized Clients

  • owner 
  • direct_access

Query Parameters

ParameterTypeRequiredDescription
attributesstringYesAttribute names and values (formatted as a JSON object) for the entity. Note that you do not need to include all the possible user profile attributes: the new record will be created using whatever attributes and attribute values you supply.
 
include_recordstring
When set to true, the API response includes all the attributes and attribute values assigned to the new record; this parameter should be included if you need to work with new record immediately after the user profile has been created. That's because, thanks to database replication issues, you might experience a brief delay before you can fully use the new record with the /entity.find or the entity.count endpoints.

Note that the record ID and UUID are also returned regardless of whether or not you use the include_record parameter.
 
type_namestring
Entity type of the entity. Required if you are authenticating with client settings.