supertokens-node
Preparing search index...
recipe/emailverification
APIInterface
Type Alias APIInterface
type
APIInterface
=
{
generateEmailVerifyTokenPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
status
:
"OK"
}
|
{
newSession
?:
SessionContainer
;
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
;
}
|
GeneralErrorResponse
,
>
)
;
isEmailVerifiedGET
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
isVerified
:
boolean
;
newSession
?:
SessionContainer
;
status
:
"OK"
}
|
GeneralErrorResponse
,
>
)
;
verifyEmailPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
|
undefined
;
tenantId
:
string
;
token
:
string
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
newSession
?:
SessionContainer
;
status
:
"OK"
;
user
:
UserEmailInfo
;
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
|
GeneralErrorResponse
,
>
)
;
}
Index
Properties
generate
Email
Verify
TokenPOST
is
Email
VerifiedGET
verify
EmailPOST
Properties
generate
Email
Verify
TokenPOST
generateEmailVerifyTokenPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
status
:
"OK"
}
|
{
newSession
?:
SessionContainer
;
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
;
}
|
GeneralErrorResponse
,
>
)
is
Email
VerifiedGET
isEmailVerifiedGET
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
isVerified
:
boolean
;
newSession
?:
SessionContainer
;
status
:
"OK"
}
|
GeneralErrorResponse
,
>
)
verify
EmailPOST
verifyEmailPOST
:
|
undefined
|
(
(
input
:
{
options
:
APIOptions
;
session
:
SessionContainer
|
undefined
;
tenantId
:
string
;
token
:
string
;
userContext
:
UserContext
;
}
,
)
=>
Promise
<
|
{
newSession
?:
SessionContainer
;
status
:
"OK"
;
user
:
UserEmailInfo
}
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
|
GeneralErrorResponse
,
>
)
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
generate
Email
Verify
TokenPOST
is
Email
VerifiedGET
verify
EmailPOST
supertokens-node
Loading...