Get tenant configuration (deprecated)

This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the emailPasswordEnabled, thirdPartyEnabled and passwordlessEnabled inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the firstFactors and requiredSecondaryFactors inputs. Please refer Multitenancy Docs to know the list of factorIds available.

Note: This deprecated API still returns emailPasswordEnabled, thirdPartyEnabled and passwordlessEnabled values for backward compatibility, and it’s values are derived from the firstFactors and requiredSecondaryFactors configured for the tenant. The detailed computation of the values as per CDI version is described here: https://github.com/supertokens/supertokens-core/issues/979#issuecomment-2099971371

Get a tenant config of the tenant specified by the url prefix.

SuperTokens subscription license key is required if querying any tenant other than the base tenant.

Returns recipes with their enabled flag and recipe specific configs saved in core

GET/appid-{appId}/{tenantId}/recipe/multitenancy/tenantdeprecated

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 config result

One of:

object

statusstatusOK

Allowed:OK

tenantIdtenantId

emailPasswordobject

Show properties

enabledbooleanrequired

thirdPartyobject

Show properties

enabledbooleanrequired

providersthirdPartyProviderConfig[]

Show properties

Array of thirdPartyProviderConfig

thirdPartyIdstringrequired

namestring

clientsobject[]

Show properties

Array of object

clientTypestring

clientIdstring

clientSecretstring

scopestring[]

forcePKCEboolean

additionalConfigobject

authorizationEndpointstring

authorizationEndpointQueryParamsobject

tokenEndpointstring

tokenEndpointBodyParamsobject

userInfoEndpointstring

userInfoEndpointQueryParamsobject

userInfoEndpointHeadersobject

jwksURIstring

oidcDiscoveryEndpointstring

requireEmailboolean

default: true

userInfoMapobject

Show properties

fromIdTokenPayloadobject

Show properties

userIdstring

emailstring

emailVerifiedstring

fromUserInfoAPIobject

Show properties

userIdstring

emailstring

emailVerifiedstring

passwordlessobject

Show properties

enabledbooleanrequired

firstFactorsfirstFactors

requiredSecondaryFactorsrequiredSecondaryFactors

coreConfigobject

object

statusstring

Allowed:TENANT_NOT_FOUND_ERROR

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/multitenancy/tenant" \
  -H "api-key: YOUR_API_KEY"

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

import requests

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

Response

{
  "status": "OK",
  "tenantId": "customer1",
  "emailPassword": {
    "enabled": true
  },
  "thirdParty": {
    "enabled": true,
    "providers": [
      {
        "thirdPartyId": "string",
        "name": "string",
        "clients": [
          {
            "clientType": "string",
            "clientId": "string",
            "clientSecret": "string",
            "scope": [
              "string"
            ],
            "forcePKCE": true,
            "additionalConfig": {}
          }
        ],
        "authorizationEndpoint": "string",
        "authorizationEndpointQueryParams": {},
        "tokenEndpoint": "string",
        "tokenEndpointBodyParams": {},
        "userInfoEndpoint": "string",
        "userInfoEndpointQueryParams": {},
        "userInfoEndpointHeaders": {},
        "jwksURI": "string",
        "oidcDiscoveryEndpoint": "string",
        "requireEmail": true,
        "userInfoMap": {
          "fromIdTokenPayload": {
            "userId": "string",
            "email": "string",
            "emailVerified": "string"
          },
          "fromUserInfoAPI": {
            "userId": "string",
            "email": "string",
            "emailVerified": "string"
          }
        }
      }
    ]
  },
  "passwordless": {
    "enabled": true
  },
  "firstFactors": [
    "emailpassword"
  ],
  "requiredSecondaryFactors": [
    "otp-phone"
  ],
  "coreConfig": {}
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"