@supertokens-plugins/tenant-discovery-nodejs

Type Aliases

MinimalTenantDetails

type MinimalTenantDetails = {
  displayName: string;
  tenantId: string;
};

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:13

Properties

Property	Type	Defined in
displayName	string	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:15
tenantId	string	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:14

OverrideableTenantFunctionImplementation

type OverrideableTenantFunctionImplementation = {
  getTenantIdFromEmail: (email: string) => Promise<string>;
  getTenants: (userContext?: UserContext) => Promise<MinimalTenantDetails[]>;
  isRestrictedEmailDomain: (emailDomain: string) => boolean;
  isTenantAllowedForEmail: (email: string, tenantId: string) => boolean;
  isValidTenant: (tenantId: string, userContext?: UserContext) => Promise<boolean>;
};

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:18

Properties

Property	Type	Defined in
getTenantIdFromEmail	(email: string) => Promise<string>	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:19
getTenants	(userContext?: UserContext) => Promise<MinimalTenantDetails[]>	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:20
isRestrictedEmailDomain	(emailDomain: string) => boolean	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:22
isTenantAllowedForEmail	(email: string, tenantId: string) => boolean	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:23
isValidTenant	(tenantId: string, userContext?: UserContext) => Promise<boolean>	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:21

SuperTokensPluginTenantDiscoveryPluginConfig

type SuperTokensPluginTenantDiscoveryPluginConfig = {
  enableTenantListAPI?: boolean;
};

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:3

Properties

Property	Type	Description	Defined in
enableTenantListAPI?	boolean	Option to opt-in for the tenant selector dropdown	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:5

SuperTokensPluginTenantDiscoveryPluginNormalisedConfig

type SuperTokensPluginTenantDiscoveryPluginNormalisedConfig = {
  enableTenantListAPI: boolean;
};

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:8

Properties

Property	Type	Description	Defined in
enableTenantListAPI	boolean	Option to opt-in for the tenant selector dropdown	supertokens-plugins/packages/tenant-discovery-nodejs/src/types.ts:10

Variables

default

default: {
  init: any;
};

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/index.ts:4

Type Declaration

Name	Type	Defined in
init	any	supertokens-plugins/packages/tenant-discovery-nodejs/src/index.ts:4

enableDebugLogs

enableDebugLogs: any;

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/logger.ts:4

HANDLE_BASE_PATH

const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-tenant-discovery";

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:6

init

const init: any;

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/plugin.ts:14

logDebugMessage

logDebugMessage: any;

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/logger.ts:4

PLUGIN_ERROR_NAME

const PLUGIN_ERROR_NAME: "supertokens-plugin-tenant-discovery-error";

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:8

PLUGIN_ID

const PLUGIN_ID: "supertokens-plugin-tenant-discovery" = "supertokens-plugin-tenant-discovery";

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:1

PLUGIN_SDK_VERSION

const PLUGIN_SDK_VERSION: string[];

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:4

PLUGIN_VERSION

const PLUGIN_VERSION: "0.0.1" = "0.0.1";

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:2

POPULAR_EMAIL_DOMAINS

const POPULAR_EMAIL_DOMAINS: string[];

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/constants.ts:16

This is a list of popular email domains that we do not allow to be used in email domain to tenant ID map.

This list contains the top 20 most used email domains from this list: https://email-verify.my-addr.com/list-of-most-popular-email-domains.php

Functions

getOverrideableTenantFunctionImplementation()

function getOverrideableTenantFunctionImplementation(): OverrideableTenantFunctionImplementation;

Defined in: supertokens-plugins/packages/tenant-discovery-nodejs/src/pluginImplementation.ts:6

Returns

OverrideableTenantFunctionImplementation