List apps (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 list of all apps in a connection uri domain.

Request must originate from public app and tenant.

GET/recipe/multitenancy/app/listdeprecated

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.

Header parameters

ridstring

cdi-versionstring

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

Responses

200List of apps

statusstatusOKrequired

Allowed:OK

appsobject[]required

Show properties

Array of object

appIdstring

tenantstenantConfig[]

Show properties

Array of tenantConfig

tenantIdtenantIdrequired

emailPasswordobjectrequired

Show properties

enabledbooleanrequired

thirdPartyobjectrequired

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

passwordlessobjectrequired

Show properties

enabledbooleanrequired

firstFactorsfirstFactors

requiredSecondaryFactorsrequiredSecondaryFactors

coreConfigobjectrequired

400error code 400

string

401error code 401

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

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Request

curl -X GET "/recipe/multitenancy/app/list" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/recipe/multitenancy/app/list", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/recipe/multitenancy/app/list",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "apps": [
    {
      "appId": "app1",
      "tenants": [
        {
          "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"

"Not Found"

"Internal Error"