View Your Application Settings

Endpoint URL: {identityDomain} /config/{appId} /settings


Description

Returns settings and values applied at the API client level; in the Console, these are the settings defined in the Manage Application section. This endpoint returns all the global settings as well as any custom settings configured at the global level. Your API call must have owner permissions in order to return the global settings.

By default, global settings apply to all the API clients in an application. For example, if the login_attempts setting is configured to 5, then all the API clients in the application will allow a user to make a maximum of 5 failed login attempts before temporarily locking the user out of the web site. 

There is one exception, however. If the same setting is specifically defined for a client application, then client application setting takes precedence over the global setting. For example, suppose the global settings for login_attempts is 5 but, in Client A, login_attempts is set to 3. In that case, anyone using Client A will be limited to a maximum of 3 failed login attempts.


Respects the API Client Allow List:  Yes


URI Parameters

ParameterTypeRequiredDescription
include_clientsstring
No
Returns the global API client settings as well as any settings configured for each individual API client. If not included, this parameter is set to the default value (false).

For example, suppose your global settings consist of just two values:
 
  • login_attempts
  • login_attempts_threshold
If your API clients do not include any settings other than those two, then the endpoint returns only these two settings. However, suppose Client A includes an additional setting: site_name. In that case, the endpoint returns information about login_attempts, login_attempts_threshold, and site_name.

The returned data consists of the global settings, plus any settings defined for an individual API client. (Note that the global settings are shown only once; they are not repeated for each client.)
 


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 Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg


Sample Request (curl)

This command returns settings information for the application with the ID 73jzx34tnr5ruhsze494ssgz2b.


curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \
  https://v1.api.us.janrain.com/config/73jzx34tnr5ruhsze494ssgz2b/settings 
 

      Running this command in Postman


Responses

200 OK

If your call to this endpoint succeeds, you'll get back settings information for the specified application:


{
   "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/settings",
   "cache_settings": 0,
   "custom": {
       "email_verification_url": "https://console-datateam.dev.or.janrain.com/#/verifyEmail",
    },
   "default_flow_name": "standard",
   "default_flow_version": "20170915215708415365",
   "email_method": "ses_sync",
   "email_sender_address": "\"Janrain Console\" ",
   "password_recover_url": "https://console-datateam.dev.or.janrain.com/#/passwordReset",
   "rpx_app_id": "kbcpdniaklcfajlapmif",
   "rpx_key": "69a70c57f856dcb7a28f672fc0c8e8556c1e3672",
   "rpx_realm": "capture",
   "site_name": "console-datateam.dev.or.janrain.com"
}


Error Codes

The following table includes information about some of the error codes that you could encounter when calling this endpoint.

Error Code

Description

401/403

Error Message: Authentication required.

You either failed to provide credentials or provided invalid credentials. This endpoint requires Basic authentication.

404

Error Message: Application ID not found.

You did not provide a valid application ID.

If you encounter an error when calling this endpoint your error message will look similar to this:


{
   "errors": "Authentication required."
}