View API client settings

get https://{hostname}/config/{app_id}/clients/{client_id}/settings

Returns the settings associated with a specific API client. Client settings, global settings, and custom settings are returned as separate JSON objects.

Responses

Response body

object

_self

string | null

Path used to directly access the settings in an API operation.

cache_settings

integer | null

When set to 0, API clients settings aren't cached and are refreshed with each API operation. When set to any other value, including null, client settings are cached.

default_flow_name

string | null

Flow used in OAuth API operations if you don't set the flow parameter. This is also the fallback flow name setting for Customer Care Portal if ccp_flow_name isn't set.

default_flow_version

string | null

Version of the flow used in OAuth API operations if you don't set the flow_version parameter. This is also the fallback flow version setting for Customer Care Portal if ccp_flow_version isn't set.

email_method

string | null

Method for generating emails during the registration flow. If Akamai is managing your transactional emails this should always be set to ses_sync.

password_recover_url

string | null

Base URL used when generating a password reset link.

rpx_app_id

string | null

Unique identifier of your Social Login application. This can be found on the Settings page of your Social Login dashboard.

rpx_key

string | null

API key of your social login application. This can be found on the Manage Application page in the Console.

rpx_realm

string | null

Realm of your Social Login application if you're using a standard Identity Cloud domain. You can find this value on the Manage Application page in the Console.

site_name

string | null

Specifies the name of the site that sent a transactional email.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/config/app_id/clients/client_id/settings \
3
     --header 'accept: application/json'


xxxxxxxxxx
23
 
1
{
2
  "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/clients/nhjsdtjwvaytevc2w5sx42skggvjn7bu/settings",
3
  "default_flow_name": "standard",
4
  "default_flow_version": "20170915215708415365",
5
  "email_method": "ses_sync",
6
  "rpx_app_id": "kbcpdniaklcfajlapmif",
7
  "rpx_key": "69a70c57f856dcb7a28f672fc0c8e8556c1e3672",
8
  "rpx_realm": "capture",
9
  "site_name": "New Test Site",
10
  "_global": {
11
    "_self": "/config/73jzx34tnr5ruhsze494ssgz2b/settings",
12
    "cache_settings": 0,
13
    "default_flow_name": "standard",
14
    "default_flow_version": "20170915215708415365",
15
    "email_method": "ses_sync",
16
    "password_recover_url": "https://documentation.akamai.com/#/passwordReset",
17
    "rpx_app_id": "kbcpdniaklcfajlapmif",
18
    "rpx_key": "69a70c57f856dcb7a28f672fc0c8e8556c1e3672",
19
    "rpx_realm": "capture",
20
    "site_name": "https://documentation.akamai.com"
21
  },
22
  "custom": {}
23
}

200Successful response

401Not authorized.

404Not found.