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-
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:
|
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"
}