View a Client Setting

Endpoint URL: {registrationDomain} /settings/get




Description

For a given API client, returns the value associated with the specified key. If a value for the key has not been configured at the client scope then the application-wide default value for that key is returned. If the key has no application default value, then a NULL value is returned.


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 the value of the owner key associated with the API client 67890fghij67890fghij.


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

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
keystringYesKey to be retrieved. You can use the /settings/keys endpoint to return a list of available keys.
 
for_client_idstring
Client ID of the client to retrieve the key from. Only the application owner is authorized to send requests using this parameter.
 


Responses

200 OK

Response Example (application/json)


{
  "result": "Jay",
  "stat": "ok"
}