Class default

constructor

• new default(): default

  Returns default

StaticError

Staticinit

StaticPluginError

StaticRecipeUserId

StaticUser

StaticconvertToRecipeUserId

• convertToRecipeUserId(recipeUserId: string): RecipeUserId

  Parameters

  • recipeUserId: string

  Returns RecipeUserId

StaticcreateUserIdMapping

• createUserIdMapping(
      input: {
          externalUserId: string;
          externalUserIdInfo?: string;
          force?: boolean;
          superTokensUserId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<
      | { status: "OK"
      | "UNKNOWN_SUPERTOKENS_USER_ID_ERROR" }
      | {
          doesExternalUserIdExist: boolean;
          doesSuperTokensUserIdExist: boolean;
          status: "USER_ID_MAPPING_ALREADY_EXISTS_ERROR";
      },
  >

  Parameters

  • input: {
        externalUserId: string;
        externalUserIdInfo?: string;
        force?: boolean;
        superTokensUserId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<
      | { status: "OK"
      | "UNKNOWN_SUPERTOKENS_USER_ID_ERROR" }
      | {
          doesExternalUserIdExist: boolean;
          doesSuperTokensUserIdExist: boolean;
          status: "USER_ID_MAPPING_ALREADY_EXISTS_ERROR";
      },
  >

StaticdeleteUser

• deleteUser(
      userId: string,
      removeAllLinkedAccounts?: boolean,
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK" }>

  Parameters

  • userId: string
  • removeAllLinkedAccounts: boolean = true
  • OptionaluserContext: Record<string, any>

  Returns Promise<{ status: "OK" }>

StaticdeleteUserIdMapping

• deleteUserIdMapping(
      input: {
          force?: boolean;
          userContext?: Record<string, any>;
          userId: string;
          userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
      },
  ): Promise<{ didMappingExist: boolean; status: "OK" }>

  Parameters

  • input: {
        force?: boolean;
        userContext?: Record<string, any>;
        userId: string;
        userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
    }

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

StaticgetAllCORSHeaders

• getAllCORSHeaders(): string[]

  Returns string[]

StaticgetAvailableFirstFactors

• getAvailableFirstFactors(
      tenantId: string,
      session?: SessionContainer,
      userContext?: Record<string, any>,
  ): Promise<any>

  Parameters

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

  Returns Promise<any>

StaticgetRequestFromUserContext

• getRequestFromUserContext(
      userContext: undefined | UserContext,
  ): undefined | BaseRequest

  Parameters

  • userContext: undefined | UserContext

  Returns undefined | BaseRequest

StaticgetUser

• getUser(
      userId: string,
      userContext?: Record<string, any>,
  ): Promise<undefined | User>

  Parameters

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

  Returns Promise<undefined | User>

StaticgetUserCount

• getUserCount(
      includeRecipeIds?: string[],
      tenantId?: string,
      userContext?: Record<string, any>,
  ): Promise<number>

  Parameters

  • OptionalincludeRecipeIds: string[]
  • OptionaltenantId: string
  • OptionaluserContext: Record<string, any>

  Returns Promise<number>

StaticgetUserIdMapping

• getUserIdMapping(
      input: {
          userContext?: Record<string, any>;
          userId: string;
          userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
      },
  ): Promise<
      | {
          externalUserId: string;
          externalUserIdInfo: undefined
          | string;
          status: "OK";
          superTokensUserId: string;
      }
      | { status: "UNKNOWN_MAPPING_ERROR" },
  >

  Parameters

  • input: {
        userContext?: Record<string, any>;
        userId: string;
        userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
    }

  Returns Promise<
      | {
          externalUserId: string;
          externalUserIdInfo: undefined
          | string;
          status: "OK";
          superTokensUserId: string;
      }
      | { status: "UNKNOWN_MAPPING_ERROR" },
  >

StaticgetUsersNewestFirst

• getUsersNewestFirst(
      input: {
          includeRecipeIds?: string[];
          limit?: number;
          paginationToken?: string;
          query?: { [key: string]: string };
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<{ nextPaginationToken?: string; users: User[] }>

  Parameters

  • input: {
        includeRecipeIds?: string[];
        limit?: number;
        paginationToken?: string;
        query?: { [key: string]: string };
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<{ nextPaginationToken?: string; users: User[] }>

StaticgetUsersOldestFirst

• getUsersOldestFirst(
      input: {
          includeRecipeIds?: string[];
          limit?: number;
          paginationToken?: string;
          query?: { [key: string]: string };
          tenantId: string;
          userContext?: Record<string, any>;
      },
  ): Promise<{ nextPaginationToken?: string; users: User[] }>

  Parameters

  • input: {
        includeRecipeIds?: string[];
        limit?: number;
        paginationToken?: string;
        query?: { [key: string]: string };
        tenantId: string;
        userContext?: Record<string, any>;
    }

  Returns Promise<{ nextPaginationToken?: string; users: User[] }>

StaticisRecipeInitialized

• isRecipeInitialized(recipeId: string): boolean

  Parameters

  • recipeId: string

  Returns boolean

StaticlistUsersByAccountInfo

• listUsersByAccountInfo(
      tenantId: string,
      accountInfo: AccountInfoInput,
      doUnionOfAccountInfo?: boolean,
      userContext?: Record<string, any>,
  ): Promise<User[]>

  Parameters

  • tenantId: string
  • accountInfo: AccountInfoInput
  • doUnionOfAccountInfo: boolean = false
  • OptionaluserContext: Record<string, any>

  Returns Promise<User[]>

StaticupdateOrDeleteUserIdMappingInfo

• updateOrDeleteUserIdMappingInfo(
      input: {
          externalUserIdInfo?: string;
          userContext?: Record<string, any>;
          userId: string;
          userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
      },
  ): Promise<{ status: "OK" | "UNKNOWN_MAPPING_ERROR" }>

  Parameters

  • input: {
        externalUserIdInfo?: string;
        userContext?: Record<string, any>;
        userId: string;
        userIdType?: "SUPERTOKENS" | "EXTERNAL" | "ANY";
    }

  Returns Promise<{ status: "OK" | "UNKNOWN_MAPPING_ERROR" }>