View Your Client Settings

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



Description

Returns the settings associated with a specific API client. The endpoint returns the following information for the specified client:

  • Client settings configured specifically for the client itself.
     
  • Settings configured at the global level. As a general rule, global settings apply to all API clients. However, if the client has its own version of the setting the client version applies. For example, suppose the global settings show this:

    login_attempts = 7

    Let’s further suppose that the API client includes this setting

    login_attempts = 4

    In this case, anyone logging on using the API client will get a maximum of 4 logon attempts before their logon privileges are temporarily suspended. This is because the API client setting (a local setting) overrides the global setting.

    Note, however, that there are some settings which can only be configured at the global level. For example, you can configure {entity_type}_distinguisher_field at the individual client level; however, that setting will be ignored. That's because {entity_type}_distinguisher_field is only valid when configured at the global scope.
     
  • Custom settings defined for the client. Custom settings are defined as any setting not included in the client settings.

Client settings, global settings, and custom settings are returned as separate JSON objects.

To return settings information for a specified API client, your API call must run with either owner credentials or with the API credentials of the client in question.  

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


Respects the API Client Allow List:  Yes



Authorization

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 API client with the client ID nhjsdtjwvaytevc2w5sx42skggvjn7b.


curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \
  https://v1.api.us.janrain.com/config/73jzx34tnr5ruhsze494ssgz2b/clients/nhjsdtjwvaytevc2w5sx42skggvjn7bu/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 API client:


{
   "_global": {
       "_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"
    },
   "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/nhjsdtjwvaytevc2w5sx42skggvjn7bu/settings",
   "custom": {},
   "default_flow_name": "standard",
   "default_flow_version": "20170915215708415365",
   "email_method": "ses_sync",
   "email_sender_address": "\"Janrain Console\" ",
   "rpx_app_id": "kbcpdniaklcfajlapmif",
   "rpx_key": "69a70c57f856dcb7a28f672fc0c8e8556c1e3672",
   "rpx_realm": "capture",
   "site_name": "New Test Site"
}

@janrain.com>@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: Client ID not found.

Error Message: Application ID not found.

You did not provide a valid application and/or client ID.

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


{
   "errors": "Authentication required."
}