/config/{app_id}/settings/options

Each API client has a collection of property settings; the currently-configured property settings for an API client can be found in the Janrain Console in the Manage Properties section:

However, it's unlikely that any one client has all the possible client settings configured; more typically, a client will have a relatively small number of configured settings. So how are you supposed to know what other settings might be available to you? One way is to check the API Clients and Permissions page. 

But another approach is to use the /config/{app_id}/settings/options endpoint. That endpoint returns information similar to this for each available setting:


"globalOnly": true,
"group": "Customer Care Portal",
"name": "invitation_search_allow_empty",
    "type": "boolean",
        "values": [
            true,
            false
        ]
{
    "errors": "Authentication required."
}    

The returned data is described in the following table:

Property

Description

globalOnly

When set to true, indicates that the setting can only be configured at the global scope, and cannot be configured for individual API clients. (If you try to configure the setting at the client scope that key will be ignored.)

group

General group that the setting belongs to. Groups include:

  • Backplane
  • Customer Care Portal
  • Social Login
  • Transactional Emails
  • General Settings

name

Name of the setting. Site names are case sensitive. For example, you cannot type site_name as Site_Name. If you do, that incorrect setting will be ignored. This will include all settings that are dynamically available for an application based on the entity types that exist.

type

Datatype for the setting

values

Allowed values for the setting; for example, invitation_search_allow_emptycan only be set to true or false. A blank values property means that there is not a predefined set of values for the property:

"values": []

This endpoint includes the following methods:

  • GET


GET

Description

Returns information about available client settings. These settings are summarized on the API Client Settings page.

Authentication

This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it.

For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

Base URL

The base URL for this endpoint is your Janrain 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

Sample Request (curl)

The following command returns custom setting information for the application htb8fuhxnf8e38jrzub3c7pfrr.


curl -X GET \
    https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/settings/options

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Responses

200 OK

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


[
    {
       "globalOnly": true, 
       "group": "Backplane", 
       "name": "backplane_bus", 
       "type": "string", 
       "values": []
    }, 
    {
       "globalOnly": true, 
       "group": "Backplane", 
       "name": "backplane_password", 
       "type": "string", 
       "values": []
    }, 
    {
       "globalOnly": true, 
       "group": "Backplane", 
       "name": "backplane_server", 
       "type": "string", 
       "values": [
            "backplane1.janrainbackplane.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 that error message will look similar to this:


{
   "errors": "Authentication required."
}