supertokens-node
Preparing search index...
recipe/emailverification
RecipeInterface
Type Alias RecipeInterface
type
RecipeInterface
=
{
createEmailVerificationToken
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
,
>
;
isEmailVerified
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
boolean
>
;
revokeEmailVerificationTokens
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
{
status
:
"OK"
}
>
;
unverifyEmail
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
{
status
:
"OK"
}
>
;
verifyEmailUsingToken
(
input
:
{
attemptAccountLinking
:
boolean
;
tenantId
:
string
;
token
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
status
:
"OK"
;
user
:
UserEmailInfo
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
,
>
;
}
Index
Methods
create
Email
Verification
Token
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
Methods
create
Email
Verification
Token
createEmailVerificationToken
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
,
>
Parameters
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
|
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
,
>
is
Email
Verified
isEmailVerified
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
boolean
>
Parameters
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
}
Returns
Promise
<
boolean
>
revoke
Email
Verification
Tokens
revokeEmailVerificationTokens
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
tenantId
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
{
status
:
"OK"
}
>
unverify
Email
unverifyEmail
(
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
input
:
{
email
:
string
;
recipeUserId
:
RecipeUserId
;
userContext
:
UserContext
}
Returns
Promise
<
{
status
:
"OK"
}
>
verify
Email
Using
Token
verifyEmailUsingToken
(
input
:
{
attemptAccountLinking
:
boolean
;
tenantId
:
string
;
token
:
string
;
userContext
:
UserContext
;
}
,
)
:
Promise
<
|
{
status
:
"OK"
;
user
:
UserEmailInfo
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
,
>
Parameters
input
:
{
attemptAccountLinking
:
boolean
;
tenantId
:
string
;
token
:
string
;
userContext
:
UserContext
;
}
Returns
Promise
<
|
{
status
:
"OK"
;
user
:
UserEmailInfo
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
create
Email
Verification
Token
is
Email
Verified
revoke
Email
Verification
Tokens
unverify
Email
verify
Email
Using
Token
supertokens-node
Loading...