/entity

Returns the specified user profile.

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

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: Retrieve user data for a specific ID and created date

This command returns user profile information for the user with the ID 999.


curl -X POST -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user \
  --data-urlencode id=999 \
  https://my-app.janraincapture.com/entity

Running this command in Postman

Example Response


{
  "result": {
    "birthday": null,
    "familyName": "Doe",
    "profiles": [],
    "id": 999,
    "middleName": null,
    "emailVerified": "2015-11-15 01:58:01 +0000",
    "primaryAddress": {
      "company": null,
      "address2": "",
      "stateAbbreviation": "NM",
      "zipPlus4": null,
      "city": "",
      "address1": "",
      "phone": "5551234567",
      "zip": "",
      "mobile": null,
      "country": "United States"
    },
    "gender": "male",
    "lastUpdated": "2016-03-13 19:39:17.856608 +0000",
    "password": null,
    "photos": [],
    "email": "johndoe@example.com",
    "givenName": "John",
    "currentLocation": null,
    "deactivateAccount": null,
    "lastLogin": "2016-03-13 19:39:17 +0000",
    "created": "2015-11-15 01:58:01.862312 +0000",
    "displayName": "John Doe",
    "uuid": "12345abc-1234-abcd-1234-12345abcde12",
    "aboutMe": null,
    "display": null,
    "statuses": []
  },
  "stat": "ok"
}

Example: Retrieve certain attributes for a specific user ID

This command returns four user profile attribute values (email, givenName, familyName and created) for the user with the ID 999. These four attributes specify the user’s email address, first name, last name, and the date his or her user account was created.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg="\
  --data-urlencode type_name=user \
  --data-urlencode id=999 \
  --data-urlencode attributes='["email", "familyName", "givenName", "created"]' \
  https://my-app.janraincapture.com/entity

Running this command in Postman

Example Response


{
  "result": {
    "familyName": "Parker",
    "email":"parkerm@example.com",
    "givenName":"Matthew",
    "created":"2015-12-31 18:54:59.900339 +0000"
  },
    "stat":"ok"
  }

Example: Retrieve data for a user with specific email address

This command retrieves the value of the created attribute for the user with the email address parkerm@example.com. The created attribute tells you the date and time that the user account was created.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user \
  --data-urlencode key_attribute=email \
  --data-urlencode key_value='"parkerm@example.com"' \
  --data-urlencode attributes='["created"]'\
  https://my-app.janraincapture.com/entity

Example Response


{
  "result":{
    "created":"2015-10-05 21:37:13.031989 +0000"
  },
  "stat":"ok"
}

Example: Validate a User's Password

This command verifies the password for the user with the ID 1537. To do this, the call specifies the attribute to be checked (password) and the supplied password value (p@ssw0rd). If the supplied value matches the user’s actual password, then the values included in the attributes parameter are returned (in this case, the user’s displayName). If the supplied value does not match the user’s actual password, then a 350 (invalid_password_value) error is returned.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user \
  --data-urlencode id=1537 \
  --data-urlencode password_attribute=password \
  --data-urlencode password_value=p@ssw0rd \
  --data-urlencode attributes='["displayName"]'\
  https://my-app.janraincapture.com/entity

Example Response


{
  "result":{
    "created":"2015-10-05 21:37:13.031989 +0000"
  },
  "stat":"ok"
}

Authorized Clients

owner
direct_access
direct_read_access

Query Parameters

Parameter	Type	Required	Description
attribute_name	string		Attribute to be returned. When used, values are only returned for the specified attribute. (By default, all attribute values are returned.)
attributes	string		JSON array of attributes to be returned. When used, values are only returned for the specified attributes. (By default, all attribute values are returned.)
created	string		Timestamp generated when the entity was created. If this value is present but is incorrect, the call fails.
last_udpated	string		Timestamp generated when the entity was last updated. If this value is present but is incorrect, the call fails.
type_name	string	Yes	Name of the entityType.
id	string		ID of the user record. Required unless you are using the uuid or key_attribute parameter.
uuid	string		UUID of the user record. Required unless you are using the id or key_attribute parameter.
key_attribute	string		Name of a unique attribute in the schema. This parameter is required unless you are using the uuid or id parameter, and must be used in conjunction with the key_value parameter.
key_value	string		Value assigned to the key_attribute parameter. String values must be enclosed in quotes.
password_attribute	string	Yes	Path to a schema attribute that includes a password constraint. You can use the password_attribute and password_value parameters together: use password_attribute to specify the attribute to authenticate against, and password_value to specify the authenticating password.
password_value	string		Plaintext value that is matched against the password attribute specified in the password_attribute parameter. If successful, the entity is returned. If unsuccessful, the API call fails.

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

POST

Running this Command in Postman

How to Create an Authentication String