diff --git a/CHANGELOG.md b/CHANGELOG.md
index da7a4f26a..88a44c77e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,7 +5,15 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
-## [unreleased]
+## [0.35.5] - 2023-10-06
+
+### Changes
+
+- Setting `autocomplete` in passwordless forms for email, phone and OTP
+
+### Fixes
+
+- Fixed shadow dom issue in nextjs dev mode by checking if a shadow root is already attached to the div before creating one.
### Example changes
diff --git a/docs/classes/index.default.html b/docs/classes/index.default.html
index 466541dd0..82d3e1d86 100644
--- a/docs/classes/index.default.html
+++ b/docs/classes/index.default.html
@@ -1 +1 @@
-
\ No newline at end of file
diff --git a/docs/classes/recipe_authRecipe.default.html b/docs/classes/recipe_authRecipe.default.html
index 9f7de095a..5c61e17b2 100644
--- a/docs/classes/recipe_authRecipe.default.html
+++ b/docs/classes/recipe_authRecipe.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_emailpassword.default.html b/docs/classes/recipe_emailpassword.default.html
index 8af4d1bbd..8af5204ed 100644
--- a/docs/classes/recipe_emailpassword.default.html
+++ b/docs/classes/recipe_emailpassword.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_emailverification.default.html b/docs/classes/recipe_emailverification.default.html
index 037276702..cebf38b3f 100644
--- a/docs/classes/recipe_emailverification.default.html
+++ b/docs/classes/recipe_emailverification.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_multitenancy.default.html b/docs/classes/recipe_multitenancy.default.html
index d23ad0bf5..0d0d54ec8 100644
--- a/docs/classes/recipe_multitenancy.default.html
+++ b/docs/classes/recipe_multitenancy.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_passwordless.default.html b/docs/classes/recipe_passwordless.default.html
index c1c5cca27..09e13751b 100644
--- a/docs/classes/recipe_passwordless.default.html
+++ b/docs/classes/recipe_passwordless.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_recipeModule.default.html b/docs/classes/recipe_recipeModule.default.html
index 1a4a854cc..887d8aba1 100644
--- a/docs/classes/recipe_recipeModule.default.html
+++ b/docs/classes/recipe_recipeModule.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_session.BooleanClaim.html b/docs/classes/recipe_session.BooleanClaim.html
index 9ac1bb682..1a50cca3c 100644
--- a/docs/classes/recipe_session.BooleanClaim.html
+++ b/docs/classes/recipe_session.BooleanClaim.html
@@ -1,3 +1,3 @@
-BooleanClaim | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_session.PrimitiveArrayClaim.html b/docs/classes/recipe_session.PrimitiveArrayClaim.html
index bec932e28..c7af4ea92 100644
--- a/docs/classes/recipe_session.PrimitiveArrayClaim.html
+++ b/docs/classes/recipe_session.PrimitiveArrayClaim.html
@@ -1,3 +1,3 @@
-PrimitiveArrayClaim | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_session.PrimitiveClaim.html b/docs/classes/recipe_session.PrimitiveClaim.html
index 64ba1f103..316ddb35f 100644
--- a/docs/classes/recipe_session.PrimitiveClaim.html
+++ b/docs/classes/recipe_session.PrimitiveClaim.html
@@ -1,3 +1,3 @@
-PrimitiveClaim | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_session.default.html b/docs/classes/recipe_session.default.html
index d3459780c..1c3158ea6 100644
--- a/docs/classes/recipe_session.default.html
+++ b/docs/classes/recipe_session.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.ActiveDirectory.html b/docs/classes/recipe_thirdparty.ActiveDirectory.html
index 3b6f70c6f..01fd20d0d 100644
--- a/docs/classes/recipe_thirdparty.ActiveDirectory.html
+++ b/docs/classes/recipe_thirdparty.ActiveDirectory.html
@@ -1 +1 @@
-ActiveDirectory | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Apple.html b/docs/classes/recipe_thirdparty.Apple.html
index 7f066e81c..9b93aa8b5 100644
--- a/docs/classes/recipe_thirdparty.Apple.html
+++ b/docs/classes/recipe_thirdparty.Apple.html
@@ -1 +1 @@
-Apple | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Bitbucket.html b/docs/classes/recipe_thirdparty.Bitbucket.html
index 2bdecb2cf..45c3e5d4f 100644
--- a/docs/classes/recipe_thirdparty.Bitbucket.html
+++ b/docs/classes/recipe_thirdparty.Bitbucket.html
@@ -1 +1 @@
-Bitbucket | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.BoxySAML.html b/docs/classes/recipe_thirdparty.BoxySAML.html
index d64e09464..18d6b89da 100644
--- a/docs/classes/recipe_thirdparty.BoxySAML.html
+++ b/docs/classes/recipe_thirdparty.BoxySAML.html
@@ -1 +1 @@
-BoxySAML | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Discord.html b/docs/classes/recipe_thirdparty.Discord.html
index d52a516e7..088caf555 100644
--- a/docs/classes/recipe_thirdparty.Discord.html
+++ b/docs/classes/recipe_thirdparty.Discord.html
@@ -1 +1 @@
-Discord | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Facebook.html b/docs/classes/recipe_thirdparty.Facebook.html
index f16bb4584..c9e94e436 100644
--- a/docs/classes/recipe_thirdparty.Facebook.html
+++ b/docs/classes/recipe_thirdparty.Facebook.html
@@ -1 +1 @@
-Facebook | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Github.html b/docs/classes/recipe_thirdparty.Github.html
index f84c91023..a9d999b4f 100644
--- a/docs/classes/recipe_thirdparty.Github.html
+++ b/docs/classes/recipe_thirdparty.Github.html
@@ -1 +1 @@
-Github | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Gitlab.html b/docs/classes/recipe_thirdparty.Gitlab.html
index 5914f40c8..5173bf954 100644
--- a/docs/classes/recipe_thirdparty.Gitlab.html
+++ b/docs/classes/recipe_thirdparty.Gitlab.html
@@ -1 +1 @@
-Gitlab | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Google.html b/docs/classes/recipe_thirdparty.Google.html
index 708fb59f0..59a242d75 100644
--- a/docs/classes/recipe_thirdparty.Google.html
+++ b/docs/classes/recipe_thirdparty.Google.html
@@ -1 +1 @@
-Google | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.GoogleWorkspaces.html b/docs/classes/recipe_thirdparty.GoogleWorkspaces.html
index e546fc6f2..95c926e18 100644
--- a/docs/classes/recipe_thirdparty.GoogleWorkspaces.html
+++ b/docs/classes/recipe_thirdparty.GoogleWorkspaces.html
@@ -1 +1 @@
-GoogleWorkspaces | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.LinkedIn.html b/docs/classes/recipe_thirdparty.LinkedIn.html
index cbe1e3081..6156ef0d2 100644
--- a/docs/classes/recipe_thirdparty.LinkedIn.html
+++ b/docs/classes/recipe_thirdparty.LinkedIn.html
@@ -1 +1 @@
-LinkedIn | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Okta.html b/docs/classes/recipe_thirdparty.Okta.html
index fb983fb91..1e1e22ff9 100644
--- a/docs/classes/recipe_thirdparty.Okta.html
+++ b/docs/classes/recipe_thirdparty.Okta.html
@@ -1 +1 @@
-Okta | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.Twitter.html b/docs/classes/recipe_thirdparty.Twitter.html
index 97e58c4c2..efa09039f 100644
--- a/docs/classes/recipe_thirdparty.Twitter.html
+++ b/docs/classes/recipe_thirdparty.Twitter.html
@@ -1 +1 @@
-Twitter | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.default.html b/docs/classes/recipe_thirdparty.default.html
index c532f1f79..308eb1699 100644
--- a/docs/classes/recipe_thirdparty.default.html
+++ b/docs/classes/recipe_thirdparty.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdpartyemailpassword.default.html b/docs/classes/recipe_thirdpartyemailpassword.default.html
index dc514866c..b4bf7989f 100644
--- a/docs/classes/recipe_thirdpartyemailpassword.default.html
+++ b/docs/classes/recipe_thirdpartyemailpassword.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdpartypasswordless.default.html b/docs/classes/recipe_thirdpartypasswordless.default.html
index e94db2a0a..c93eb1e0d 100644
--- a/docs/classes/recipe_thirdpartypasswordless.default.html
+++ b/docs/classes/recipe_thirdpartypasswordless.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/classes/recipe_userroles.default.html b/docs/classes/recipe_userroles.default.html
index 437906fee..842e049dc 100644
--- a/docs/classes/recipe_userroles.default.html
+++ b/docs/classes/recipe_userroles.default.html
@@ -1 +1 @@
-default | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/index.html b/docs/modules/index.html
index 8906b42d8..78ce42107 100644
--- a/docs/modules/index.html
+++ b/docs/modules/index.html
@@ -1 +1 @@
-index | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_emailpassword.html b/docs/modules/recipe_emailpassword.html
index bca6f2214..bf8c180f6 100644
--- a/docs/modules/recipe_emailpassword.html
+++ b/docs/modules/recipe_emailpassword.html
@@ -1,4 +1,4 @@
-recipe/emailpassword | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_emailverification.html b/docs/modules/recipe_emailverification.html
index f59af8657..5fdb383b1 100644
--- a/docs/modules/recipe_emailverification.html
+++ b/docs/modules/recipe_emailverification.html
@@ -1,4 +1,4 @@
-recipe/emailverification | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_multitenancy.html b/docs/modules/recipe_multitenancy.html
index 23b92fdf2..9cab3d691 100644
--- a/docs/modules/recipe_multitenancy.html
+++ b/docs/modules/recipe_multitenancy.html
@@ -2,4 +2,4 @@
Gets enabled login methods and their configuration
throws
STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"
Parameters
input: { options?: RecipeFunctionOptions; tenantId?: string; userContext: any }
\ No newline at end of file
diff --git a/docs/modules/recipe_passwordless.html b/docs/modules/recipe_passwordless.html
index 75b194c81..1da563268 100644
--- a/docs/modules/recipe_passwordless.html
+++ b/docs/modules/recipe_passwordless.html
@@ -1,4 +1,4 @@
-recipe/passwordless | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_session.html b/docs/modules/recipe_session.html
index 08bbcc808..ace6c1da7 100644
--- a/docs/modules/recipe_session.html
+++ b/docs/modules/recipe_session.html
@@ -1,8 +1,8 @@
-recipe/session | supertokens-auth-react
Decides if we need to refresh the claim value before checking the payload with validate.
E.g.: if the information in the payload is expired, or is not sufficient for this validator.
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdparty.html b/docs/modules/recipe_thirdparty.html
index 0e23a49a5..211b44f03 100644
--- a/docs/modules/recipe_thirdparty.html
+++ b/docs/modules/recipe_thirdparty.html
@@ -1,4 +1,4 @@
-recipe/thirdparty | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdpartyemailpassword.html b/docs/modules/recipe_thirdpartyemailpassword.html
index 455c24769..75616e607 100644
--- a/docs/modules/recipe_thirdpartyemailpassword.html
+++ b/docs/modules/recipe_thirdpartyemailpassword.html
@@ -1,4 +1,4 @@
-recipe/thirdpartyemailpassword | supertokens-auth-react
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdpartypasswordless.html b/docs/modules/recipe_thirdpartypasswordless.html
index c2de4f42a..3b5858364 100644
--- a/docs/modules/recipe_thirdpartypasswordless.html
+++ b/docs/modules/recipe_thirdpartypasswordless.html
@@ -1,4 +1,4 @@
-recipe/thirdpartypasswordless | supertokens-auth-react
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass BooleanClaim
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
config: PrimitiveClaimConfig & { onFailureRedirection?: ValidationFailureCallback; showAccessDeniedOnFailure?: boolean }
Returns BooleanClaim
Properties
Readonly default Max Age In Seconds
Readonly id
Readonly refresh
Type declaration
Makes an API call that will refresh the claim in the token.
Parameters
userContext: any
Returns Promise<void>
validators
Methods
get Last Fetched Time
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get Value From Payload
Parameters
payload: any
Optional _userContext: any
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass PrimitiveArrayClaim<T>
Type Parameters
T
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type Parameters
T
Parameters
config: PrimitiveArrayClaimConfig & { onFailureRedirection?: ValidationFailureCallback; showAccessDeniedOnFailure?: boolean }
Returns PrimitiveArrayClaim<T>
Properties
Readonly default Max Age In Seconds
Readonly id
Readonly refresh
Type declaration
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass PrimitiveArrayClaim<T>
Type Parameters
T
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type Parameters
T
Parameters
config: PrimitiveArrayClaimConfig & { onFailureRedirection?: ValidationFailureCallback; showAccessDeniedOnFailure?: boolean }
Returns PrimitiveArrayClaim<T>
Properties
Readonly default Max Age In Seconds
Readonly id
Readonly refresh
Type declaration
Makes an API call that will refresh the claim in the token.
Parameters
userContext: any
Returns Promise<void>
validators
Type declaration
excludes:function
Parameters
val: ValueType
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
excludes All:function
Parameters
val: ValueType[]
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
includes:function
Parameters
val: ValueType
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
includes All:function
Parameters
val: ValueType[]
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
includes Any:function
Parameters
val: ValueType[]
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
Methods
get Last Fetched Time
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get Value From Payload
Parameters
payload: any
Optional _userContext: any
Returns T[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass PrimitiveClaim<T>
Type Parameters
T
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type Parameters
T
Parameters
config: PrimitiveClaimConfig & { onFailureRedirection?: ValidationFailureCallback; showAccessDeniedOnFailure?: boolean }
Returns PrimitiveClaim<T>
Properties
Readonly default Max Age In Seconds
Readonly id
Readonly refresh
Type declaration
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass PrimitiveClaim<T>
Type Parameters
T
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type Parameters
T
Parameters
config: PrimitiveClaimConfig & { onFailureRedirection?: ValidationFailureCallback; showAccessDeniedOnFailure?: boolean }
Returns PrimitiveClaim<T>
Properties
Readonly default Max Age In Seconds
Readonly id
Readonly refresh
Type declaration
Makes an API call that will refresh the claim in the token.
Parameters
userContext: any
Returns Promise<void>
validators
Type declaration
has Value:function
Parameters
val: ValueType
Optional maxAgeInSeconds: number
Optional id: string
Returns SessionClaimValidator
Methods
get Last Fetched Time
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get Value From Payload
Parameters
payload: any
Optional _userContext: any
Returns T
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Components Override Provider
Static Session Auth
Static use Claim Value
Type declaration
Type Parameters
T
Parameters
claim: SessionClaim<T>
Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }
Static use Session Context
Type declaration
Returns SessionContextType
Methods
Static add Axios Interceptors
Parameters
axiosInstance: any
Optional userContext: any
Returns void
Static attempt Refreshing Session
Returns Promise<boolean>
Static does Session Exist
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<boolean>
Static get Access Token
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | string>
Static get Access Token Payload Securely
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<any>
Static get Claim Value
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user Context?: any
Returns Promise<undefined | T>
Static get Invalid Claims From Response
Parameters
input: { response: Response | { data: any }; userContext: any }
response: Response | { data: any }
user Context: any
Returns Promise<ClaimValidationError[]>
Static get User Id
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<string>
Static init
Parameters
Optional config: InputType
Returns RecipeInitResult<unknown, unknown, unknown, any>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static validate Claims
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user Context?: any
override Global Claim Validators?:function
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Components Override Provider
Static Session Auth
Static use Claim Value
Type declaration
Type Parameters
T
Parameters
claim: SessionClaim<T>
Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }
Static use Session Context
Type declaration
Returns SessionContextType
Methods
Static add Axios Interceptors
Parameters
axiosInstance: any
Optional userContext: any
Returns void
Static attempt Refreshing Session
Returns Promise<boolean>
Static does Session Exist
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<boolean>
Static get Access Token
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | string>
Static get Access Token Payload Securely
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<any>
Static get Claim Value
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user Context?: any
Returns Promise<undefined | T>
Static get Invalid Claims From Response
Parameters
input: { response: Response | { data: any }; userContext: any }
response: Response | { data: any }
user Context: any
Returns Promise<ClaimValidationError[]>
Static get User Id
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<string>
Static init
Parameters
Optional config: InputType
Returns RecipeInitResult<unknown, unknown, unknown, any>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static validate Claims
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user Context?: any
override Global Claim Validators?:function
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass ActiveDirectory
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns ActiveDirectory
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass ActiveDirectory
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns ActiveDirectory
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Apple
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Apple
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Apple
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Apple
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Bitbucket
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Bitbucket
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Bitbucket
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Bitbucket
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass BoxySAML
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns BoxySAML
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass BoxySAML
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns BoxySAML
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Discord
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Discord
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Discord
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Discord
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Facebook
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Facebook
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Facebook
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Facebook
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Github
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Github
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Github
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Github
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Gitlab
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Gitlab
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Gitlab
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Gitlab
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Google
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Google
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Google
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Google
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass GoogleWorkspaces
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns GoogleWorkspaces
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass GoogleWorkspaces
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns GoogleWorkspaces
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass LinkedIn
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns LinkedIn
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass LinkedIn
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns LinkedIn
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Okta
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Okta
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Okta
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: BuiltInProviderConfig
Returns Okta
Properties
Readonly config
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: BuiltInProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Twitter
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: TwitterProviderConfig
Returns Twitter
Properties
Readonly config
Private use Legacy Twitter Logo
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: TwitterProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass Twitter
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional config: TwitterProviderConfig
Returns Twitter
Properties
Readonly config
Private use Legacy Twitter Logo
Static Private Optional instance
Accessors
id
Returns string
name
Returns string
Methods
get Button
Parameters
Optional name: string
Returns Element
get Logo
Returns Element
get RedirectURIOn Provider Dashboard
Returns undefined | string
get RedirectURL
Returns string
Static init
Parameters
Optional config: TwitterProviderConfig
Returns default
Static reset
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static email Password Sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
Static email Password Sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
Static get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Static third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static email Password Sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
Static email Password Sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
Static get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Static third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static clear Passwordless Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static consume Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static create Passwordless Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static does Passwordless User Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static does Passwordless User Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static get Passwordless Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get Passwordless Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
Static get Passwordless Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get Third Party AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get Third Party State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static resend Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
Static set Passwordless Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Active Directory
Static Apple
Static Bitbucket
Static BoxySAML
Static Components Override Provider
Static Discord
Static Facebook
Static Github
Static Gitlab
Static Google
Static Google Workspaces
Static Linked In
Static Okta
Static Twitter
Methods
Static clear Passwordless Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static consume Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static create Passwordless Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Static does Passwordless User Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static does Passwordless User Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
Static get Passwordless Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get Passwordless Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
Static get Passwordless Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
Static get Third Party AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
Static get Third Party State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
Static init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
Static redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
Static resend Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
Static set Passwordless Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
Static sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Static third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Returns default
Properties
Static Permission Claim
Static User Role Claim
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactClass default
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Returns default
Properties
Static Permission Claim
Static User Role Claim
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule index
Index
Classes
Variables
Functions
Variables
Const Super Tokens Wrapper
Functions
change Language
Parameters
language: string
Returns Promise<void>
init
Parameters
config: SuperTokensConfig
Returns void
load Translation
Parameters
store: TranslationStore
Returns void
redirect To Auth
Parameters
Optional options: { history?: any; queryParams?: any; redirectBack?: boolean; show?: "signin" | "signup" }
Optional history?: any
Optional query Params?: any
Optional redirect Back?: boolean
Optional show?: "signin" | "signup"
Returns Promise<void>
use Translation
Returns TranslationFunc
use User Context
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule index
Index
Classes
Variables
Functions
Variables
Const Super Tokens Wrapper
Functions
change Language
Parameters
language: string
Returns Promise<void>
init
Parameters
config: SuperTokensConfig
Returns void
load Translation
Parameters
store: TranslationStore
Returns void
redirect To Auth
Parameters
Optional options: { history?: any; queryParams?: any; redirectBack?: boolean; show?: "signin" | "signup" }
Optional history?: any
Optional query Params?: any
Optional redirect Back?: boolean
Optional show?: "signin" | "signup"
Returns Promise<void>
use Translation
Returns TranslationFunc
use User Context
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/emailpassword
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
does Email Exist:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/emailpassword
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
does Email Exist:function
Check if an email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext: any }
email: string
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
@@ -24,4 +24,4 @@{status: "OK", doesExist: boolean}
Submit a new password for the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}
if successfullUser Input
Variables
Const Email Password Components Override Provider
Functions
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Generated using TypeDoc
User Input
Variables
Const Email Password Components Override Provider
Functions
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/emailverification
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
Type declaration
action: "VERIFY_EMAIL"
On Handle Event Context
Type declaration
action: "VERIFY_EMAIL_SENT" | "EMAIL_VERIFIED_SUCCESSFUL"
user Context: any
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
get Email Verification Token FromURL:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/emailverification
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
Type declaration
action: "VERIFY_EMAIL"
On Handle Event Context
Type declaration
action: "VERIFY_EMAIL_SENT" | "EMAIL_VERIFIED_SUCCESSFUL"
user Context: any
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
get Email Verification Token FromURL:function
Reads and returns the email verification token from the current URL
Parameters
input: { userContext: any }
user Context: any
Returns string
The "token" query parameter from the current location
get Tenant Id FromURL:function
Verify an email
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"
Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
-{status: "OK"}
if successfullUser Input
Variables
Const Email Verification Claim
Const Email Verification Components Override Provider
Functions
get Email Verification Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
is Email Verified
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
send Verification Email
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
verify Email
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
Generated using TypeDoc
User Input
Variables
Const Email Verification Claim
Const Email Verification Components Override Provider
Functions
get Email Verification Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
is Email Verified
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
send Verification Email
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
verify Email
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
Generated using TypeDoc
Gets enabled login methods and their configuration
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"
Parameters
input: { options?: RecipeFunctionOptions; tenantId?: string; userContext: any }
Optional options?: RecipeFunctionOptions
Optional tenant Id?: string
user Context: any
Returns Promise<{ emailPassword: { enabled: boolean }; fetchResponse: Response; passwordless: { enabled: boolean }; status: "OK"; thirdParty: { enabled: boolean; providers: { id: string; name: string }[] } }>
-{status: OK, emailpassword, passwordless, thirdParty}
if successfulget Tenant Id:function
Parameters
input: { userContext: any }
user Context: any
Returns undefined | string | Promise<undefined | string>
User Input
Variables
Const Allowed Domains Claim
Const Multitenancy Components Override Provider
Functions
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<any, any, any, any>
Generated using TypeDoc
get Tenant Id:function
Parameters
input: { userContext: any }
user Context: any
Returns undefined | string | Promise<undefined | string>
User Input
Variables
Const Allowed Domains Claim
Const Multitenancy Components Override Provider
Functions
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<any, any, any, any>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/passwordless
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
Recipe Interface
Type declaration
clear Login Attempt Info:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/passwordless
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
Recipe Interface
Type declaration
clear Login Attempt Info:function
Clear any information about login attempts from storage
Parameters
input: { userContext: any }
user Context: any
Returns Promise<void>
consume Code:function
Log the user in using the input code or link code
@@ -34,4 +34,4 @@Parameters
input: { deviceId: string; options?: RecipeFunctionOptions; preAuthSessionId: string; tenantId: string | undefined; userContext: any }
device Id: string
Optional options?: RecipeFunctionOptions
pre Auth Session Id: string
tenant Id: string | undefined
user Context: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
{status: "OK"}
if succesfulset Login Attempt Info:function
Set information about the current login attempt to storage
-Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId?: string } & CustomStateProperties; userContext: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId?: string } & CustomStateProperties
user Context: any
Returns Promise<void>
User Input
Variables
Const Passwordless Components Override Provider
Functions
clear Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
consume Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
create Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
does Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
get Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
resend Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
set Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId?: string } & CustomStateProperties; userContext: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId?: string } & CustomStateProperties
user Context: any
Returns Promise<void>
User Input
Variables
Const Passwordless Components Override Provider
Functions
clear Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
consume Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
create Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
does Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
get Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
resend Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
set Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/session
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Claim Validation Error
Type declaration
Optional reason?: any
validator Id: string
Claim Validation Result
Input Type
Recipe Interface
Type declaration
add Axios Interceptors:function
Parameters
input: { axiosInstance: any; userContext: any }
axios Instance: any
user Context: any
Returns void
add Fetch Interceptors And Return Modified Fetch:function
Parameters
input: { originalFetch: any; userContext: any }
original Fetch: any
user Context: any
Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
Parameters
input: URL | RequestInfo
Optional init: RequestInit
Returns Promise<Response>
addXMLHttp Request Interceptor:function
Parameters
input: { userContext: any }
user Context: any
Returns void
does Session Exist:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<boolean>
get Access Token Payload Securely:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<any>
get Global Claim Validators:function
Parameters
input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any }
claim Validators Added By Other Recipes: SessionClaimValidator[]
user Context: any
Returns SessionClaimValidator[]
get Invalid Claims From Response:function
Parameters
input: { response: { data: any } | Response; userContext: any }
response: { data: any } | Response
user Context: any
Returns Promise<ClaimValidationError[]>
get User Id:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<string>
should Do Interception Based On Url:function
Parameters
toCheckUrl: string
apiDomain: string
sessionTokenBackendDomain: undefined | string
Returns boolean
sign Out:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<void>
validate Claims:function
Parameters
input: { claimValidators: SessionClaimValidator[]; userContext: any }
claim Validators: SessionClaimValidator[]
user Context: any
Returns Promise<ClaimValidationError[]>
Session Claim
Type Parameters
ValueType
Type declaration
get Last Fetched Time:function
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get Value From Payload:function
Parameters
payload: any
Optional _userContext: any
Returns undefined | ValueType
refresh:function
Parameters
userContext: any
Returns Promise<void>
Session Claim Validator
Type declaration
Readonly id: string
refresh:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/session
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Claim Validation Error
Type declaration
Optional reason?: any
validator Id: string
Claim Validation Result
Input Type
Recipe Interface
Type declaration
add Axios Interceptors:function
Parameters
input: { axiosInstance: any; userContext: any }
axios Instance: any
user Context: any
Returns void
add Fetch Interceptors And Return Modified Fetch:function
Parameters
input: { originalFetch: any; userContext: any }
original Fetch: any
user Context: any
Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
Parameters
input: URL | RequestInfo
Optional init: RequestInit
Returns Promise<Response>
addXMLHttp Request Interceptor:function
Parameters
input: { userContext: any }
user Context: any
Returns void
does Session Exist:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<boolean>
get Access Token Payload Securely:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<any>
get Global Claim Validators:function
Parameters
input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any }
claim Validators Added By Other Recipes: SessionClaimValidator[]
user Context: any
Returns SessionClaimValidator[]
get Invalid Claims From Response:function
Parameters
input: { response: { data: any } | Response; userContext: any }
response: { data: any } | Response
user Context: any
Returns Promise<ClaimValidationError[]>
get User Id:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<string>
should Do Interception Based On Url:function
Parameters
toCheckUrl: string
apiDomain: string
sessionTokenBackendDomain: undefined | string
Returns boolean
sign Out:function
Parameters
input: { userContext: any }
user Context: any
Returns Promise<void>
validate Claims:function
Parameters
input: { claimValidators: SessionClaimValidator[]; userContext: any }
claim Validators: SessionClaimValidator[]
user Context: any
Returns Promise<ClaimValidationError[]>
Session Claim
Type Parameters
ValueType
Type declaration
get Last Fetched Time:function
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get Value From Payload:function
Parameters
payload: any
Optional _userContext: any
Returns undefined | ValueType
refresh:function
Parameters
userContext: any
Returns Promise<void>
Session Claim Validator
Type declaration
Readonly id: string
refresh:function
Makes an API call that will refresh the claim in the token.
Parameters
userContext: any
Returns Promise<void>
should Refresh:function
Decides if we need to refresh the claim value before checking the payload with
validate
. E.g.: if the information in the payload is expired, or is not sufficient for this validator.Parameters
accessTokenPayload: any
userContext: any
Returns boolean | Promise<boolean>
validate:function
Decides if the claim is valid based on the accessTokenPayload object (and not checking DB or anything else)
-Parameters
accessTokenPayload: any
userContext: any
Returns ClaimValidationResult | Promise<ClaimValidationResult>
Session Context Type
Variables
Const Session Auth
Const Session Components Override Provider
Const Session Context
Functions
add Axios Interceptors
Parameters
axiosInstance: any
Optional userContext: any
Returns void
attempt Refreshing Session
Returns Promise<boolean>
does Session Exist
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<boolean>
get Access Token
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | string>
get Access Token Payload Securely
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<any>
get Claim Value
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user Context?: any
Returns Promise<undefined | T>
get Invalid Claims From Response
Parameters
input: { response: Response | { data: any }; userContext: any }
response: Response | { data: any }
user Context: any
Returns Promise<ClaimValidationError[]>
get User Id
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<string>
init
Parameters
Optional config: InputType
Returns RecipeInitResult<unknown, unknown, unknown, any>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
use Claim Value
Type Parameters
T
Parameters
claim: SessionClaim<T>
Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }
use Session Context
Returns SessionContextType
validate Claims
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user Context?: any
override Global Claim Validators?:function
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
Parameters
accessTokenPayload: any
userContext: any
Returns ClaimValidationResult | Promise<ClaimValidationResult>
Session Context Type
Variables
Const Session Auth
Const Session Components Override Provider
Const Session Context
Functions
add Axios Interceptors
Parameters
axiosInstance: any
Optional userContext: any
Returns void
attempt Refreshing Session
Returns Promise<boolean>
does Session Exist
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<boolean>
get Access Token
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | string>
get Access Token Payload Securely
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<any>
get Claim Value
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user Context?: any
Returns Promise<undefined | T>
get Invalid Claims From Response
Parameters
input: { response: Response | { data: any }; userContext: any }
response: Response | { data: any }
user Context: any
Returns Promise<ClaimValidationError[]>
get User Id
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<string>
init
Parameters
Optional config: InputType
Returns RecipeInitResult<unknown, unknown, unknown, any>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
use Claim Value
Type Parameters
T
Parameters
claim: SessionClaim<T>
Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }
use Session Context
Returns SessionContextType
validate Claims
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user Context?: any
override Global Claim Validators?:function
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdparty
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
generate State To Send ToOAuth Provider:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdparty
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Type declaration
action: PreAndPostAPIHookAction
request Init: RequestInit
url: string
user Context: any
Recipe Interface
Type declaration
generate State To Send ToOAuth Provider:function
Generate a new state that will be sent to the third party provider
Parameters
Optional input: { frontendRedirectURI?: string; userContext: any }
Optional frontend RedirectURI?: string
user Context: any
Returns string
string
get Auth Error FromURL:function
Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; tenantId?: string; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
{status: OK, user, createdNewRecipeUser: boolean}
if succesfulverify And Get State Or Throw Error:function
Verify that the state recieved from the third party provider matches the one in storage
-Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Components Override Provider
Functions
get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Components Override Provider
Functions
get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdpartyemailpassword
Index
References
Classes
Type Aliases
Variables
Functions
References
Active Directory
Re-exports ActiveDirectoryApple
Re-exports AppleBitbucket
Re-exports BitbucketBoxySAML
Re-exports BoxySAMLDiscord
Re-exports DiscordFacebook
Re-exports FacebookGithub
Re-exports GithubGitlab
Re-exports GitlabGoogle
Re-exports GoogleGoogle Workspaces
Re-exports GoogleWorkspacesLinked In
Re-exports LinkedInOkta
Re-exports OktaTwitter
Re-exports TwitterType Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Recipe Interface
Type declaration
does Email Exist:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdpartyemailpassword
Index
References
Classes
Type Aliases
Variables
Functions
References
Active Directory
Re-exports ActiveDirectoryApple
Re-exports AppleBitbucket
Re-exports BitbucketBoxySAML
Re-exports BoxySAMLDiscord
Re-exports DiscordFacebook
Re-exports FacebookGithub
Re-exports GithubGitlab
Re-exports GitlabGoogle
Re-exports GoogleGoogle Workspaces
Re-exports GoogleWorkspacesLinked In
Re-exports LinkedInOkta
Re-exports OktaTwitter
Re-exports TwitterType Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Recipe Interface
Type declaration
does Email Exist:function
Check if an email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext: any }
email: string
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
@@ -51,4 +51,4 @@{status: "OK", doesExist: boolean}
Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; tenantId?: string; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
{status: OK, user, createdNewRecipeUser: boolean}
if succesfulverify And Get State Or Throw Error:function
Verify that the state recieved from the third party provider matches the one in storage
-Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Email Password Components Override Provider
Functions
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
email Password Sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
email Password Sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Email Password Components Override Provider
Functions
does Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
email Password Sign In
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
email Password Sign Up
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
get AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get Reset Password Token FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
Optional config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
send Password Reset Email
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
submit New Password
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form Fields: { id: string; value: string }[]
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdpartypasswordless
Index
References
Classes
Type Aliases
Variables
Functions
References
Active Directory
Re-exports ActiveDirectoryApple
Re-exports AppleBitbucket
Re-exports BitbucketBoxySAML
Re-exports BoxySAMLDiscord
Re-exports DiscordFacebook
Re-exports FacebookGithub
Re-exports GithubGitlab
Re-exports GitlabGoogle
Re-exports GoogleGoogle Workspaces
Re-exports GoogleWorkspacesLinked In
Re-exports LinkedInOkta
Re-exports OktaTwitter
Re-exports TwitterType Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Recipe Interface
Type declaration
clear Passwordless Login Attempt Info:function
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/thirdpartypasswordless
Index
References
Classes
Type Aliases
Variables
Functions
References
Active Directory
Re-exports ActiveDirectoryApple
Re-exports AppleBitbucket
Re-exports BitbucketBoxySAML
Re-exports BoxySAMLDiscord
Re-exports DiscordFacebook
Re-exports FacebookGithub
Re-exports GithubGitlab
Re-exports GitlabGoogle
Re-exports GoogleGoogle Workspaces
Re-exports GoogleWorkspacesLinked In
Re-exports LinkedInOkta
Re-exports OktaTwitter
Re-exports TwitterType Aliases
Get RedirectionURLContext
On Handle Event Context
PreAPIHook Context
Recipe Interface
Type declaration
clear Passwordless Login Attempt Info:function
Clear any information about login attempts from storage
Parameters
input: { userContext: any }
user Context: any
Returns Promise<void>
consume Passwordless Code:function
Log the user in using the input code or link code
@@ -62,4 +62,4 @@Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user Context: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; tenantId?: string; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
{status: OK, user, createdNewRecipeUser: boolean}
if succesfulverify And Get Third Party State Or Throw Error:function
Verify that the state recieved from the third party provider matches the one in storage
-Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Passwordless Components Override Provider
Functions
clear Passwordless Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
consume Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
create Passwordless Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
does Passwordless User Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
does Passwordless User Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Passwordless Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Passwordless Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
get Passwordless Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Third Party AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get Third Party State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
resend Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
set Passwordless Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc
Type Parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: string | undefined; stateObjectFromStorage: StateObject & CustomStateProperties | undefined; userContext: any }
state From Auth Provider: string | undefined
state Object From Storage: StateObject & CustomStateProperties | undefined
user Context: any
Returns Promise<StateObject & CustomStateProperties>
User Input
Variables
Const Thirdparty Passwordless Components Override Provider
Functions
clear Passwordless Login Attempt Info
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
consume Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
create Passwordless Code
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
does Passwordless User Email Exist
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
does Passwordless User Phone Number Exist
Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone Number: string
Optional user Context?: any
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get Passwordless Link Code FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Passwordless Login Attempt Info
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomLoginAttemptInfoProperties>
get Passwordless Pre Auth Session Id FromURL
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns string
get Third Party AuthorisationURLWith Query Params And Set State
Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend RedirectURI: string
Optional options?: RecipeFunctionOptions
Optional redirectURIOn Provider Dashboard?: string
third Party Id: string
Optional user Context?: any
Returns Promise<string>
get Third Party State And Other Info From Storage
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns undefined | StateObject & CustomStateProperties
init
Parameters
config: UserInput
Returns RecipeInitResult<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
redirect To Third Party Login
Parameters
input: { thirdPartyId: string; userContext?: any }
third Party Id: string
Optional user Context?: any
Returns Promise<{ status: "OK" | "ERROR" }>
resend Passwordless Code
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
set Passwordless Login Attempt Info
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt Info: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties
Optional user Context?: any
Returns Promise<void>
sign Out
Parameters
Optional input: { userContext?: any }
Optional user Context?: any
Returns Promise<void>
third Party Sign In And Up
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user Context?: any
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
Generated using TypeDoc