/entity.create

Creates a new user profile.

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

Parameter Type Required Description
attributes string Yes Attribute 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_record string When set to true, the API response includes all the attributes and attribute values assigned to the new record. 
 
type_name string entityType of the entity. Required if you are authenticating with client settings.