Class default

constructor

• new default(): default

  Returns default

Staticinit

StaticassociateUserToTenant

• associateUserToTenant(
      tenantId: string,
      recipeUserId: RecipeUserId,
      userContext?: Record<string, any>,
  ): Promise<
      | { status: "OK"; wasAlreadyAssociated: boolean }
      | {
          status:
              | "EMAIL_ALREADY_EXISTS_ERROR"
              | "UNKNOWN_USER_ID_ERROR"
              | "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
              | "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR";
      }
      | { reason: string; status: "ASSOCIATION_NOT_ALLOWED_ERROR" },
  >

  Parameters

  • tenantId: string
  • recipeUserId: RecipeUserId
  • OptionaluserContext: Record<string, any>

  Returns Promise<
      | { status: "OK"; wasAlreadyAssociated: boolean }
      | {
          status:
              | "EMAIL_ALREADY_EXISTS_ERROR"
              | "UNKNOWN_USER_ID_ERROR"
              | "PHONE_NUMBER_ALREADY_EXISTS_ERROR"
              | "THIRD_PARTY_USER_ALREADY_EXISTS_ERROR";
      }
      | { reason: string; status: "ASSOCIATION_NOT_ALLOWED_ERROR" },
  >

StaticcreateOrUpdateTenant

• createOrUpdateTenant(
      tenantId: string,
      config?: {
          coreConfig?: { [key: string]: any };
          firstFactors?: null | string[];
          requiredSecondaryFactors?: null | string[];
      },
      userContext?: Record<string, any>,
  ): Promise<{ createdNew: boolean; status: "OK" }>

  Parameters

  • tenantId: string
  • Optionalconfig: {
        coreConfig?: { [key: string]: any };
        firstFactors?: null | string[];
        requiredSecondaryFactors?: null | string[];
    }
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ createdNew: boolean; status: "OK" }>

StaticcreateOrUpdateThirdPartyConfig

• createOrUpdateThirdPartyConfig(
      tenantId: string,
      config: ProviderConfig,
      skipValidation?: boolean,
      userContext?: Record<string, any>,
  ): Promise<{ createdNew: boolean; status: "OK" }>

  Parameters

  • tenantId: string
  • config: ProviderConfig
  • OptionalskipValidation: boolean
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ createdNew: boolean; status: "OK" }>

StaticdeleteTenant

• deleteTenant(
      tenantId: string,
      userContext?: Record<string, any>,
  ): Promise<{ didExist: boolean; status: "OK" }>

  Parameters

  • tenantId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ didExist: boolean; status: "OK" }>

StaticdeleteThirdPartyConfig

• deleteThirdPartyConfig(
      tenantId: string,
      thirdPartyId: string,
      userContext?: Record<string, any>,
  ): Promise<{ didConfigExist: boolean; status: "OK" }>

  Parameters

  • tenantId: string
  • thirdPartyId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ didConfigExist: boolean; status: "OK" }>

StaticdisassociateUserFromTenant

• disassociateUserFromTenant(
      tenantId: string,
      recipeUserId: RecipeUserId,
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK"; wasAssociated: boolean }>

  Parameters

  • tenantId: string
  • recipeUserId: RecipeUserId
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK"; wasAssociated: boolean }>

StaticgetTenant

• getTenant(
      tenantId: string,
      userContext?: Record<string, any>,
  ): Promise<undefined | { status: "OK" } & TenantConfig>

  Parameters

  • tenantId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<undefined | { status: "OK" } & TenantConfig>

StaticlistAllTenants

• listAllTenants(
      userContext?: Record<string, any>,
  ): Promise<
      { status: "OK"; tenants: ({ tenantId: string } & TenantConfig)[] },
  >

  Parameters

  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK"; tenants: ({ tenantId: string } & TenantConfig)[] }>