supertokens-node
Preparing search index...
recipe/thirdparty
RecipeInterface
Type Alias RecipeInterface
type
RecipeInterface
=
{
getProvider
(
input
:
{
clientType
?:
string
;
tenantId
:
string
;
thirdPartyId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
undefined
|
TypeProvider
>
;
manuallyCreateOrUpdateUser
(
input
:
{
email
:
string
;
isVerified
:
boolean
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"EMAIL_CHANGE_NOT_ALLOWED_ERROR"
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
;
signInUp
(
input
:
{
email
:
string
;
isVerified
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
;
}
Index
Methods
get
Provider
manually
Create
Or
Update
User
sign
In
Up
Methods
get
Provider
getProvider
(
input
:
{
clientType
?:
string
;
tenantId
:
string
;
thirdPartyId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
undefined
|
TypeProvider
>
Parameters
input
:
{
clientType
?:
string
;
tenantId
:
string
;
thirdPartyId
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
undefined
|
TypeProvider
>
manually
Create
Or
Update
User
manuallyCreateOrUpdateUser
(
input
:
{
email
:
string
;
isVerified
:
boolean
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"EMAIL_CHANGE_NOT_ALLOWED_ERROR"
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
Parameters
input
:
{
email
:
string
;
isVerified
:
boolean
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"EMAIL_CHANGE_NOT_ALLOWED_ERROR"
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
sign
In
Up
signInUp
(
input
:
{
email
:
string
;
isVerified
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
Parameters
input
:
{
email
:
string
;
isVerified
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
session
:
SessionContainer
|
undefined
;
shouldTryLinkingWithSessionUser
:
boolean
|
undefined
;
tenantId
:
string
;
thirdPartyId
:
string
;
thirdPartyUserId
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
|
{
createdNewRecipeUser
:
boolean
;
oAuthTokens
:
{
[
key
:
string
]:
any
}
;
rawUserInfoFromProvider
:
{
fromIdTokenPayload
?:
{
[
key
:
string
]:
any
}
;
fromUserInfoAPI
?:
{
[
key
:
string
]:
any
}
;
}
;
recipeUserId
:
RecipeUserId
;
status
:
"OK"
;
user
:
User
;
}
|
{
reason
:
string
;
status
:
"SIGN_IN_UP_NOT_ALLOWED"
}
|
{
reason
:
|
"EMAIL_VERIFICATION_REQUIRED"
|
"RECIPE_USER_ID_ALREADY_LINKED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
|
"SESSION_USER_ACCOUNT_INFO_ALREADY_ASSOCIATED_WITH_ANOTHER_PRIMARY_USER_ID_ERROR"
;
status
:
"LINKING_TO_SESSION_USER_FAILED"
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Provider
manually
Create
Or
Update
User
sign
In
Up
supertokens-node
Loading...