Get the core config

Get the core config of the tenant specified by the url prefix, along with the metadata of each of the fields.

GET/appid-{appId}/{tenantId}/recipe/dashboard/tenant/core-config

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Responses

200Tenant core config result

statusstatusOKrequired

Allowed:OK

configobject[]required

Show properties

Array of object

keystring

valueTypestring | null

Allowed:stringnumberboolean

valuenumber | null

descriptionstring

isDifferentAcrossTenantsboolean

possibleValuesstring[] | null

isNullableboolean

defaultValuenumber | null

isPluginPropertyboolean

isPluginPropertyEditableboolean

400error code 400

string

401error code 401

string

402error code 402

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Request

curl -X GET "/appid-{appId}/public/recipe/dashboard/tenant/core-config" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/public/recipe/dashboard/tenant/core-config", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/public/recipe/dashboard/tenant/core-config",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "config": [
    {
      "key": "password_reset_token_lifetime",
      "valueType": "number",
      "value": 3600000,
      "description": "Time in milliseconds for how long a password reset token / link is valid for. [Default: 3600000 (1 hour)]",
      "isDifferentAcrossTenants": true,
      "possibleValues": [
        "string"
      ],
      "isNullable": false,
      "defaultValue": 3600000,
      "isPluginProperty": false,
      "isPluginPropertyEditable": false
    }
  ]
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"