Endpoint URL: {registrationDomain} /settings/get_default
Description
Returns the application-wide default value for the specified key. If the key does not exist a NULL value is returned.
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 | Yes | Yes | Yes | Yes |
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 Request
This command returns the default value of the owner key associated with the social login application that uses the URL https://my-app.janraincapture.com.
curl -X POST \ -H "Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=" \ --data-urlencode key=owner \ https://my-app.janraincapture.com/settings/get_default
Running this command in Postman
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
key | string | Yes | Key whose value is to be retrieved. You can use the /settings/keys endpoint to return a list of available keys. |
Responses
200 OK
Response Example (application/json)
{
"result": "null",
"stat": "ok"
}