supertokens-node
Preparing search index...
recipe/thirdparty
APIInterface
Type Alias APIInterface
type
APIInterface
=
{
appleRedirectHandlerPOST
:
|
undefined
|
(
(
input
:
{
formPostInfoFromProvider
:
{
[
key
:
string
]:
any
}
;
options
:
APIOptions
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
void
>
)
;
authorisationUrlGET
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
provider
:
TypeProvider
;
redirectURIOnProviderDashboard
:
string
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
pkceCodeVerifier
?:
string
;
status
:
"OK"
;
urlWithQueryParams
:
string
;
}
|
GeneralErrorResponse
,
>
)
;
signInUpPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
provider
:
TypeProvider
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
userContext
:
UserContext
;
}
&
(
|
{
redirectURIInfo
:
{
pkceCodeVerifier
?:
string
;
redirectURIOnProviderDashboard
:
string
;
redirectURIQueryParams
:
any
;
}
;
}
|
{
oAuthTokens
:
{
[
key
:
string
]:
any
}
}
)
,
)
=>
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
session
:
SessionContainer
;
status
:
"OK"
;
user
:
User
;
}
|
{
status
:
"NO_EMAIL_GIVEN_BY_PROVIDER"
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
GeneralErrorResponse
,
>
)
;
}
Index
Properties
apple
Redirect
HandlerPOST
authorisation
UrlGET
sign
In
UpPOST
Properties
apple
Redirect
HandlerPOST
appleRedirectHandlerPOST
:
|
undefined
|
(
(
input
:
{
formPostInfoFromProvider
:
{
[
key
:
string
]:
any
}
;
options
:
APIOptions
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
void
>
)
authorisation
UrlGET
authorisationUrlGET
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
provider
:
TypeProvider
;
redirectURIOnProviderDashboard
:
string
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
pkceCodeVerifier
?:
string
;
status
:
"OK"
;
urlWithQueryParams
:
string
;
}
|
GeneralErrorResponse
,
>
)
sign
In
UpPOST
signInUpPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
provider
:
TypeProvider
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
userContext
:
UserContext
;
}
&
(
|
{
redirectURIInfo
:
{
pkceCodeVerifier
?:
string
;
redirectURIOnProviderDashboard
:
string
;
redirectURIQueryParams
:
any
;
}
;
}
|
{
oAuthTokens
:
{
[
key
:
string
]:
any
}
}
)
,
)
=>
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
session
:
SessionContainer
;
status
:
"OK"
;
user
:
User
;
}
|
{
status
:
"NO_EMAIL_GIVEN_BY_PROVIDER"
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
GeneralErrorResponse
,
>
)
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
apple
Redirect
HandlerPOST
authorisation
UrlGET
sign
In
UpPOST
supertokens-node
Loading...