List Your API Clients

Endpoint URL: {registrationDomain} /clients/list

Description

Returns a list of all the API clients in your application. Only the owner client can make this API call.

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 Basic 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

This command returns information about all the API clients that have the direct_access feature and/or the access_issuer feature.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
   --data-urlencode has_features='["direct_access","access_issuer"]' \
   https://my-app.janraincapture.com/clients/list

Running this command in Postman

Query Parameters

Parameter	Type	Required	Description
has_features	string		A JSON array of feature names; only clients that have at least one of the features in the array will be returned. Allowed values are: owner access_issuer direct_read_access direct_access

Responses

200 OK

Example Error Response


{
  "argument_name": "has_features",
  "request_id": "n7uudpznfbrs79gu",
  "code": 200,
  "error_description": "has_features was not valid for the following reason: the JSON is not syntactically valid",
  "error": "invalid_argument",
  "stat": "error"
}

Response Example (application/json)


{
  "results": [
    {
      "whitelist": [
        "0.0.0.0/0"
      ],
      "features": [
        "access_issuer",
        "direct_access",
        "owner"
      ],
      "description": "application owner",
      "client_id": "12345abcde12345abcde",
      "client_secret": "edcba54321edcba54321"
    }
  ],
  "stat": "ok"
}

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} /clients/list

Description

Respects the API Client Allow List: Yes

API Client Permissions

Authentication

Base URL

Examples

Query Parameters

Responses

Running this Command in Postman

How to Create an Authentication String

Rate this Article