Upsert tenant

Creates or updates a tenant.

SuperTokens subscription license key is required.

The firstFactors can be set to following values:

• null: When set to null, all the login methods will be available for the tenant.
• [] (empty array): No login methods will be enabled for the tenant.
• ['factor1', 'factor2', ...] (non-empty array): The list of login methods to enable for the tenant. For eg. if this is set to ['emailpassword', 'thirdparty'], the users of the tenant will be able to login using emailpassword and third party providers.

List of built-in first factors are as follows:

• Email password auth: emailpassword
• Social login / enterprise SSO auth: thirdparty
• Passwordless:
  • With email OTP: otp-email
  • With SMS OTP: otp-phone
  • With email magic link: link-email
  • With SMS magic link: link-phone

If first factors are not specified while creating a new tenant, all the login methods will be disabled by default.

The requiredSecondaryFactors can be set to following values:

• null: When set to null, no secondary factors will be required for the users of the tenant.
• ['factor1', 'factor2', ...] (non-empty array): The list of factors that the users of the tenant must complete post the first factor login. For eg. if this is set to ['otp-phone', 'totp'], the users of the tenant will be required to complete either phone OTP or TOTP post the first factor login.

List of built-in secondary factors are as follows:

• Email password auth: emailpassword
• Social login / enterprise SSO auth: thirdparty
• Passwordless:
  • With email OTP: otp-email
  • With SMS OTP: otp-phone
  • With email magic link: link-email
  • With SMS magic link: link-phone
• Time based OTP: totp

If updating an existing tenant,

1. core will keep the existing state of login methods and only update the ones that are specified in the request body.
2. Core config will be merged into existing config. To delete a key in the config, use a null value

The request must originate from public tenant, and the new tenant will use connectionUriDomain and app from which the request originates.

Note: Updation of core config is not allowed for the default connectionUriDomain, public app and tenant. In order to update config for the default connectionUriDomain, public app and tenant, you must edit the config.yaml or the docker env directly.

curl -X PUT "/appid-{appId}/recipe/multitenancy/tenant/v2" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "tenantId": "customer1",
  "firstFactors": [
    "emailpassword"
  ],
  "requiredSecondaryFactors": [
    "otp-phone"
  ],
  "coreConfig": {}
}'

const response = await fetch("/appid-{appId}/recipe/multitenancy/tenant/v2", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "tenantId": "customer1",
  "firstFactors": [
    "emailpassword"
  ],
  "requiredSecondaryFactors": [
    "otp-phone"
  ],
  "coreConfig": {}
})
});

import requests

response = requests.put(
    "/appid-{appId}/recipe/multitenancy/tenant/v2",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "tenantId": "customer1",
  "firstFactors": [
    "emailpassword"
  ],
  "requiredSecondaryFactors": [
    "otp-phone"
  ],
  "coreConfig": {}
},
)

{
  "status": "OK",
  "createdNew": true
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"