Module recipe/thirdparty

appleRedirectHandlerPOST: undefined | ((input: { formPostInfoFromProvider: {}; options: APIOptions; userContext: any }) => Promise<void>)

authorisationUrlGET: undefined | ((input: { options: APIOptions; provider: TypeProvider; redirectURIOnProviderDashboard: string; tenantId: string; userContext: any }) => Promise<{ pkceCodeVerifier?: string; status: "OK"; urlWithQueryParams: string } | GeneralErrorResponse>)

signInUpPOST: undefined | ((input: { options: APIOptions; provider: TypeProvider; tenantId: string; userContext: any } & ({ redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: any } } | { oAuthTokens: {} })) => Promise<{ createdNewUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; session: SessionContainer; status: "OK"; user: User } | { status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | GeneralErrorResponse>)

appInfo: NormalisedAppinfo

config: TypeNormalisedInput

isInServerlessEnv: boolean

providers: ProviderInput[]

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

getProvider:function

• getProvider(input: { clientType?: string; tenantId: string; thirdPartyId: string; userContext: any }): Promise<undefined | TypeProvider>

• Parameters

  • input: { clientType?: string; tenantId: string; thirdPartyId: string; userContext: any }

    • Optional clientType?: string

    • tenantId: string

    • thirdPartyId: string

    • userContext: any

  Returns Promise<undefined | TypeProvider>

getUserById:function

• getUserById(input: { userContext: any; userId: string }): Promise<undefined | User>

• Parameters

  • input: { userContext: any; userId: string }

    • userContext: any

    • userId: string

  Returns Promise<undefined | User>

getUserByThirdPartyInfo:function

• getUserByThirdPartyInfo(input: { tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }): Promise<undefined | User>

• Parameters

  • input: { tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }

    • tenantId: string

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: any

  Returns Promise<undefined | User>

getUsersByEmail:function

• getUsersByEmail(input: { email: string; tenantId: string; userContext: any }): Promise<User[]>

• Parameters

  • input: { email: string; tenantId: string; userContext: any }

    • email: string

    • tenantId: string

    • userContext: any

  Returns Promise<User[]>

manuallyCreateOrUpdateUser:function

• manuallyCreateOrUpdateUser(input: { email: string; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }): Promise<{ createdNewUser: boolean; status: "OK"; user: User }>

• Parameters

  • input: { email: string; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }

    • email: string

    • tenantId: string

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: any

  Returns Promise<{ createdNewUser: boolean; status: "OK"; user: User }>

signInUp:function

• signInUp(input: { email: string; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }): Promise<{ createdNewUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; status: "OK"; user: User }>

• Parameters

  • input: { email: string; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; tenantId: string; thirdPartyId: string; thirdPartyUserId: string; userContext: any }

    • email: string

    • oAuthTokens: {}

      • [key: string]: any

    • rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }

      • Optional fromIdTokenPayload?: {}

        • [key: string]: any

      • Optional fromUserInfoAPI?: {}

        • [key: string]: any

    • tenantId: string

    • thirdPartyId: string

    • thirdPartyUserId: string

    • userContext: any

  Returns Promise<{ createdNewUser: boolean; oAuthTokens: {}; rawUserInfoFromProvider: { fromIdTokenPayload?: {}; fromUserInfoAPI?: {} }; status: "OK"; user: User }>

config: ProviderConfigForClientType

id: string

exchangeAuthCodeForOAuthTokens:function

• exchangeAuthCodeForOAuthTokens(input: { redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: any }; userContext: any }): Promise<any>

• Parameters

  • input: { redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: any }; userContext: any }

    • redirectURIInfo: { pkceCodeVerifier?: string; redirectURIOnProviderDashboard: string; redirectURIQueryParams: any }

      • Optional pkceCodeVerifier?: string

      • redirectURIOnProviderDashboard: string

      • redirectURIQueryParams: any

    • userContext: any

  Returns Promise<any>

getAuthorisationRedirectURL:function

• getAuthorisationRedirectURL(input: { redirectURIOnProviderDashboard: string; userContext: any }): Promise<{ pkceCodeVerifier?: string; urlWithQueryParams: string }>

• Parameters

  • input: { redirectURIOnProviderDashboard: string; userContext: any }

    • redirectURIOnProviderDashboard: string

    • userContext: any

  Returns Promise<{ pkceCodeVerifier?: string; urlWithQueryParams: string }>

getConfigForClientType:function

• getConfigForClientType(input: { clientType?: string; userContext: any }): Promise<ProviderConfigForClientType>

• Parameters

  • input: { clientType?: string; userContext: any }

    • Optional clientType?: string

    • userContext: any

  Returns Promise<ProviderConfigForClientType>

getUserInfo:function

• getUserInfo(input: { oAuthTokens: any; userContext: any }): Promise<UserInfo>

• Parameters

  • input: { oAuthTokens: any; userContext: any }

    • oAuthTokens: any

    • userContext: any

  Returns Promise<UserInfo>

email: string

id: string

tenantIds: string[]

thirdParty: { id: string; userId: string }

• id: string

• userId: string

timeJoined: number