Count User Profiles

Endpoint URL: {registrationDomain} /entity.count

Description

Counts the number of user profiles in an entity type that meet the specified criterial for example, you might return the number of users who live in France of the number of users who work for Akamai.

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

Note. Having problems finding user profiles that you just created? See this article for more information.

Respects the API Client Allow List: Yes

API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner	access_issuer	direct_access	direct_read_access	login_client
Yes	No	No	No	No

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 returns a count of all the records where the user has specified their date of birth (that is, all records where the birthday attribute is not set to a null value).


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode type_name=user \
  --data-urlencode filter='birthday is not null' \
  https://my-app.janraincapture.com/entity.count

Running this command in Postman

Example Response


{
  "total_count": 15,
  "stat": "ok"
}

Example Error Response


{
  "argument_name": "filter",
  "request_id": "r6fsc52quz348mmh",
  "code": 200,
  "error_description": "filter was not valid for the following reason: Unknown attribute (null)",
  "error": "invalid_argument",
  "stat": "error"
}

Query Parameters

Parameter	Type	Required	Description
filter	string	No	A query against record fields. If this parameter is not included, all records in the entity are counted. For more information on constructing queries, see entity.find.
type_name	string	Yes	entityType where the user record is stored.

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.

Endpoint URL: {registrationDomain} /entity.count

Description

Respects the API Client Allow List: Yes

API Client Permissions

Authentication

Base URL

Examples

Query Parameters

Running this Command in Postman

How to Create an Authentication String

Rate this Article