List Your Client Settings

Endpoint URL: {registrationDomain} /settings/keys




Description

Returns all the keys for the specified API client, including those from the application-wide default settings. 

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 Request

This command returns all the keys (including application-wide keys) associated with the API client fghi7890fghi7890.


curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \
  --data-urlencode for_client_id=fghi7890fghi7890 \
  https://my-app.janraincapture.com/settings/keys
  

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
for_client_idstring
Client ID of the client whose keys are being retrieved. Note that only the application owner is authorized to make requests using this parameter.
 


Responses

200 OK

Response Example (application/json)


{
  "result": [
    "level",
    "owner",
    "public"
  ],
  "stat": "ok"
}