Search
Preparing search index...
The search index is not available
supertokens-node
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
supertokens-node
recipe/thirdpartyemailpassword
default
Class default
Hierarchy
default
Index
Constructors
constructor
Properties
Apple
Error
Facebook
Github
Google
init
Methods
create
Email
Verification
Token
create
Reset
Password
Token
get
User
By
Id
get
User
By
Third
Party
Info
get
Users
By
Email
is
Email
Verified
reset
Password
Using
Token
revoke
Email
Verification
Tokens
sign
In
sign
In
Up
sign
Up
unverify
Email
update
Email
Or
Password
verify
Email
Using
Token
Constructors
constructor
new default
(
)
:
default
Returns
default
Properties
Static
Apple
Apple
:
(
config
:
TypeThirdPartyProviderAppleConfig
)
=>
TypeProvider
= ...
Type declaration
(
config
:
TypeThirdPartyProviderAppleConfig
)
:
TypeProvider
Parameters
config:
TypeThirdPartyProviderAppleConfig
Returns
TypeProvider
Static
Error
Error
:
typeof
default
= ...
Static
Facebook
Facebook
:
(
config
:
TypeThirdPartyProviderFacebookConfig
)
=>
TypeProvider
= ...
Type declaration
(
config
:
TypeThirdPartyProviderFacebookConfig
)
:
TypeProvider
Parameters
config:
TypeThirdPartyProviderFacebookConfig
Returns
TypeProvider
Static
Github
Github
:
(
config
:
TypeThirdPartyProviderGithubConfig
)
=>
TypeProvider
= ...
Type declaration
(
config
:
TypeThirdPartyProviderGithubConfig
)
:
TypeProvider
Parameters
config:
TypeThirdPartyProviderGithubConfig
Returns
TypeProvider
Static
Google
Google
:
(
config
:
TypeThirdPartyProviderGoogleConfig
)
=>
TypeProvider
= ...
Type declaration
(
config
:
TypeThirdPartyProviderGoogleConfig
)
:
TypeProvider
Parameters
config:
TypeThirdPartyProviderGoogleConfig
Returns
TypeProvider
Static
init
init
:
(
config
:
TypeInput
)
=>
RecipeListFunction
= ...
Type declaration
(
config
:
TypeInput
)
:
RecipeListFunction
Parameters
config:
TypeInput
Returns
RecipeListFunction
Methods
Static
create
Email
Verification
Token
create
Email
Verification
Token
(
userId
:
string
)
:
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
>
Parameters
userId:
string
Returns
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"EMAIL_ALREADY_VERIFIED_ERROR"
}
>
Static
create
Reset
Password
Token
create
Reset
Password
Token
(
userId
:
string
)
:
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"UNKNOWN_USER_ID_ERROR"
}
>
Parameters
userId:
string
Returns
Promise
<
{
status
:
"OK"
;
token
:
string
}
|
{
status
:
"UNKNOWN_USER_ID_ERROR"
}
>
Static
get
User
By
Id
get
User
By
Id
(
userId
:
string
)
:
Promise
<
undefined
|
User
>
Parameters
userId:
string
Returns
Promise
<
undefined
|
User
>
Static
get
User
By
Third
Party
Info
get
User
By
Third
Party
Info
(
thirdPartyId
:
string
, thirdPartyUserId
:
string
)
:
Promise
<
undefined
|
User
>
Parameters
thirdPartyId:
string
thirdPartyUserId:
string
Returns
Promise
<
undefined
|
User
>
Static
get
Users
By
Email
get
Users
By
Email
(
email
:
string
)
:
Promise
<
User
[]
>
Parameters
email:
string
Returns
Promise
<
User
[]
>
Static
is
Email
Verified
is
Email
Verified
(
userId
:
string
)
:
Promise
<
boolean
>
Parameters
userId:
string
Returns
Promise
<
boolean
>
Static
reset
Password
Using
Token
reset
Password
Using
Token
(
token
:
string
, newPassword
:
string
)
:
Promise
<
{
status
:
"OK"
|
"RESET_PASSWORD_INVALID_TOKEN_ERROR"
}
>
Parameters
token:
string
newPassword:
string
Returns
Promise
<
{
status
:
"OK"
|
"RESET_PASSWORD_INVALID_TOKEN_ERROR"
}
>
Static
revoke
Email
Verification
Tokens
revoke
Email
Verification
Tokens
(
userId
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
Returns
Promise
<
{
status
:
"OK"
}
>
Static
sign
In
sign
In
(
email
:
string
, password
:
string
)
:
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"WRONG_CREDENTIALS_ERROR"
}
>
Parameters
email:
string
password:
string
Returns
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"WRONG_CREDENTIALS_ERROR"
}
>
Static
sign
In
Up
sign
In
Up
(
thirdPartyId
:
string
, thirdPartyUserId
:
string
, email
:
{
id
:
string
;
isVerified
:
boolean
}
)
:
Promise
<
{
createdNewUser
:
boolean
;
status
:
"OK"
;
user
:
User
}
|
{
error
:
string
;
status
:
"FIELD_ERROR"
}
>
Parameters
thirdPartyId:
string
thirdPartyUserId:
string
email:
{
id
:
string
;
isVerified
:
boolean
}
id
:
string
is
Verified
:
boolean
Returns
Promise
<
{
createdNewUser
:
boolean
;
status
:
"OK"
;
user
:
User
}
|
{
error
:
string
;
status
:
"FIELD_ERROR"
}
>
Static
sign
Up
sign
Up
(
email
:
string
, password
:
string
)
:
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"EMAIL_ALREADY_EXISTS_ERROR"
}
>
Parameters
email:
string
password:
string
Returns
Promise
<
{
status
:
"OK"
;
user
:
User
}
|
{
status
:
"EMAIL_ALREADY_EXISTS_ERROR"
}
>
Static
unverify
Email
unverify
Email
(
userId
:
string
)
:
Promise
<
{
status
:
"OK"
}
>
Parameters
userId:
string
Returns
Promise
<
{
status
:
"OK"
}
>
Static
update
Email
Or
Password
update
Email
Or
Password
(
input
:
{
email
?:
string
;
password
?:
string
;
userId
:
string
}
)
:
Promise
<
{
status
:
"OK"
|
"EMAIL_ALREADY_EXISTS_ERROR"
|
"UNKNOWN_USER_ID_ERROR"
}
>
Parameters
input:
{
email
?:
string
;
password
?:
string
;
userId
:
string
}
Optional
email
?:
string
Optional
password
?:
string
user
Id
:
string
Returns
Promise
<
{
status
:
"OK"
|
"EMAIL_ALREADY_EXISTS_ERROR"
|
"UNKNOWN_USER_ID_ERROR"
}
>
Static
verify
Email
Using
Token
verify
Email
Using
Token
(
token
:
string
)
:
Promise
<
undefined
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
|
User
>
Parameters
token:
string
Returns
Promise
<
undefined
|
{
status
:
"EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"
}
|
User
>
Modules
framework
framework/aws
Lambda
framework/express
framework/fastify
framework/hapi
framework/koa
framework/loopback
index
recipe/emailpassword
recipe/emailverification
recipe/jwt
recipe/session
recipe/thirdparty
recipe/thirdpartyemailpassword
default
constructor
Apple
Error
Facebook
Github
Google
init
create
Email
Verification
Token
create
Reset
Password
Token
get
User
By
Id
get
User
By
Third
Party
Info
get
Users
By
Email
is
Email
Verified
reset
Password
Using
Token
revoke
Email
Verification
Tokens
sign
In
sign
In
Up
sign
Up
unverify
Email
update
Email
Or
Password
verify
Email
Using
Token
Generated using
TypeDoc