- https://auth0.com/docs/api/authentication -
+ https://auth0.com/docs/api/authentication +
Readonly
Private
The Auth0 client ID
The Auth0 tenant domain
Creates a new user using the options provided.
+ An instance of + User. +
- Builds the full authorize endpoint url in the - Authorization Server (AS) with given parameters. -
- A URL to the authorize endpoint with specified parameters - to redirect to for AuthZ/AuthN. -
- https://auth0.com/docs/api/authentication#authorize-client -
+ Exchanges a code obtained via + /authorize (w/PKCE) for the user's tokens +
/authorize
+ A prominse for a populated instance of + Credentials. +
CreateUserOptions): - Promise<Partial<User>> - -
- An instance of <a href="../types/User.html" - class="tsd-kind-type-alias">User</a>. -
- Exchanges a code obtained via - /authorize (w/PKCE) for the user's tokens -
- A prominse for a populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -
- https://auth0.com/docs/api-auth/grant/authorization-code-pkce -
+ Exchanges an external token obtained via a native social + authentication solution for the user's tokens +
+ A populated instance of + Credentials. +
ExchangeNativeSocialOptions,): - Promise<Credentials> - -
- Exchanges an external token obtained via a native social - authentication solution for the user's tokens -
- A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -
- https://auth0.com/docs/api/authentication#token-exchange-for-native-social -
+ Completes the Passworldess authentication with an email + connection that was started using LoginWithEmailOptions): - Promise<Credentials> - -
- Completes the Passworldess authentication with an email - connection that was started using <a - href="#passwordlesswithemail" - class="tsd-kind-method">passwordlessWithEmail</a>. -
- Log in a user using an Out Of Band authentication code - after they have received the 'mfa_required' error. The - MFA token tells the server the username or email, - password, and realm values sent on the first request. -
- Requires your client to have the - MFA OOB Grant Type enabled. See + +
+ Log in a user using an Out Of Band authentication code after + they have received the 'mfa_required' error. The MFA + token tells the server the username or email, password, and + realm values sent on the first request. +
+ Requires your client to have the + MFA OOB Grant Type enabled. See + Client Grant Types + to learn how to enable it. +
- Log in a user using the One Time Password code after - they have received the 'mfa_required' error. The MFA - token tells the server the username or email, password, - and realm values sent on the first request. -
- Requires your client to have the - MFA OTP Grant Type enabled. See + +
+ Log in a user using the One Time Password code after they + have received the 'mfa_required' error. The MFA + token tells the server the username or email, password, and + realm values sent on the first request. +
+ Requires your client to have the + MFA OTP Grant Type enabled. See + Client Grant Types + to learn how to enable it. +
- Log in a user using a multi-factor authentication - Recovery Code after they have received the - 'mfa_required' error. The MFA token tells the server the - username or email, password, and realm values sent on - the first request. -
- Requires your client to have the - MFA Grant Type enabled. See + +
+ Log in a user using a multi-factor authentication Recovery + Code after they have received the 'mfa_required' + error. The MFA token tells the server the username or email, + password, and realm values sent on the first request. +
+ Requires your client to have the MFA Grant + Type enabled. See + Client Grant Types + to learn how to enable it. +
+ Completes the Passworldess authentication with an SMS + connection that was started using LoginWithSMSOptions): - Promise<Credentials> - -
- Completes the Passworldess authentication with an SMS - connection that was started using <a - href="#passwordlesswithsms" - class="tsd-kind-method">passwordlessWithSMS</a>. -
- Builds the full logout endpoint url in the Authorization - Server (AS) with given parameters. -
- A URL to the logout endpoint with specified parameters -
- https://auth0.com/docs/api/authentication#logout -
+ Builds the full logout endpoint url in the Authorization + Server (AS) with given parameters. +
A URL to the logout endpoint with specified parameters
+ https://auth0.com/docs/api/authentication#logout +
+ Request a challenge for multi-factor authentication (MFA) + based on the challenge types supported by the application + and user. The challenge type is how the user will get the + challenge and prove possession. Supported challenge types + include: "otp" and "oob". +
+ MultifactorChallengeOTPResponse, + MultifactorChallengeOOBResponse, or + MultifactorChallengeOOBWithBindingResponse - multifactorChallenge( parameters: - MultifactorChallengeOptions,): - Promise<MultifactorChallengeResponse> - -
- Request a challenge for multi-factor authentication - (MFA) based on the challenge types supported by the - application and user. The challenge type is how the user - will get the challenge and prove possession. Supported - challenge types include: "otp" and - "oob". -
- <a - href="../types/MultifactorChallengeOTPResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOTPResponse</a>, - <a - href="../types/MultifactorChallengeOOBResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOOBResponse</a>, - or <a - href="../types/MultifactorChallengeOOBWithBindingResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOOBWithBindingResponse</a> - depending on the challenge type. -
+ Performs Auth with user credentials using the Password Realm + Grant +
PasswordlessWithEmailOptions): - Promise<void> - -
- Starts the Passworldess flow with an email connection. -
- This should be completed later using a call to <a - href="#loginwithemail" - class="tsd-kind-method">loginWithEmail</a>, - passing the OTP that was sent to the user. -
Starts the Passworldess flow with an email connection.
+ This should be completed later using a call to PasswordlessWithSMSOptions): - Promise<void> - -
- Starts the Passwordless flow with an SMS connection. -
- This should be completed later using a call to <a - href="#loginwithsms" - class="tsd-kind-method">loginWithSMS</a>, - passing the OTP that was sent to the user. -
Starts the Passwordless flow with an SMS connection.
+ This should be completed later using a call to PasswordRealmOptions): - Promise<Credentials> - -
- Performs Auth with user credentials using the Password - Realm Grant -
- https://auth0.com/docs/api-auth/grant/password#realm-support -
+ Obtain new tokens using the Refresh Token obtained during + Auth (requesting offline_access scope) +
offline_access
RefreshTokenOptions): - Promise<Credentials> - -
- Obtain new tokens using the Refresh Token obtained - during Auth (requesting - offline_access scope) -
- https://auth0.com/docs/tokens/refresh-token/current#use-a-refresh-token -
- Request an email with instructions to change password of - a user -
+ Request an email with instructions to change password of a + user +
Revoke an issued refresh token
Return user information using an access token
The user's profile information.
Optional
Delete the stored credentials
Gets the credentials that has already been saved
- The scope to request for the access token. If null - is passed, the previous scope will be kept. -
- The minimum time in seconds that the access token - should last before expiration. -
- Additional parameters to send in the request to - refresh expired credentials. -
- Whether to force refresh the credentials. It will - work only if the refresh token already exists. For - iOS, doing forceRefresh will not send the scope. - Since scope change already does force refresh, it - is better to avoid force refresh if the scope is - being changed. -
+ The scope to request for the access token. If null is + passed, the previous scope will be kept. +
+ The minimum time in seconds that the access token + should last before expiration. +
+ Additional parameters to send in the request to + refresh expired credentials. +
+ Whether to force refresh the credentials. It will work + only if the refresh token already exists. For iOS, + doing forceRefresh will not send the scope. Since + scope change already does force refresh, it is better + to avoid force refresh if the scope is being changed. +
- Returns whether this manager contains a valid - non-expired pair of credentials. -
- The minimum time in seconds that the access token - should last before expiration -
- true if a valid set of credentials are - available, or false if there are no - credentials to return. -
true
false
+ Returns whether this manager contains a valid non-expired + pair of credentials. +
+ The minimum time in seconds that the access token + should last before expiration +
+ true if a valid set of credentials are available, + or false if there are no credentials to return. +
Saves the provided credentials
Auth0 Management API User endpoints
- https://auth0.com/docs/api/management/v2#!/Users/ - Users -
+ https://auth0.com/docs/api/management/v2#!/Users/ + Users +
Returns the user by identifier
get user by identifier parameters
- https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id -
Users
+ https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id +
Patch a user's user_metadata
user_metadata
patch user metadata parameters
- https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id -
+ https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id +
+ https://auth0.com/docs/api-auth/grant/authorization-code-pkce +
+ Starts the AuthN/AuthZ transaction against the AS in the + in-app browser. +
+ To learn more about how to customize the authorize call, + check the Universal Login Page article at + https://auth0.com/docs/hosted-pages/login +
+ A poplulated instance of + Credentials. +
WebAuthorizeOptions,): - Promise<Credentials> - -
- Starts the AuthN/AuthZ transaction against the AS in the - in-app browser. -
- To learn more about how to customize the authorize call, - check the Universal Login Page article at - https://auth0.com/docs/hosted-pages/login -
- A poplulated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -
- Terminates the ongoing web-based operation and reports - back that it was cancelled. You need to call this method - within your custom Web Auth provider implementation - whenever the operation is cancelled by the user. -
+ Terminates the ongoing web-based operation and reports back + that it was cancelled. You need to call this method within + your custom Web Auth provider implementation whenever the + operation is cancelled by the user. +
- Removes Auth0 session and optionally remove the Identity - Provider session. -
- https://auth0.com/docs/logout -
+ Removes Auth0 session and optionally remove the Identity + Provider session. +
+ https://auth0.com/docs/logout +
Creates an instance of Auth0.
Your Auth0 application information
Your Auth0 application client identifier
Your Auth0 domain
+ The options for configuring the display of local + authentication prompt, authentication level + (Android only) and evaluation policy (iOS only). +
+ The telemetry information to be sent along with + the requests +
- The options for configuring the display of - local authentication prompt, authentication - level (Android only) and evaluation policy - (iOS only). -
- The telemetry information to be sent along - with the requests -
Timeout to be set for requests.
Token to be used for Management APIs
Creates a Users API client
for Management API
- The non-biometric credential used to secure the device (i. e. - PIN, pattern, or password). -
- Any biometric (e.g. fingerprint, iris, or face) on the device - that meets or exceeds the requirements for Class 3 (formerly - Strong), as defined by the Android CDD. -
- Any biometric (e.g. fingerprint, iris, or face) on the device - that meets or exceeds the requirements for Class 2 (formerly - Weak), as defined by the Android CDD. -
+ The non-biometric credential used to secure the device (i. e. + PIN, pattern, or password). +
+ Any biometric (e.g. fingerprint, iris, or face) on the device + that meets or exceeds the requirements for Class 3 (formerly + Strong), as defined by the Android CDD. +
+ Any biometric (e.g. fingerprint, iris, or face) on the device + that meets or exceeds the requirements for Class 2 (formerly + Weak), as defined by the Android CDD. +
- User authentication with biometry, Apple Watch, or the device - passcode. -
User authentication with biometry.
+ User authentication with biometry, Apple Watch, or the device + passcode. +
Presentation styles for when using SFSafariViewController on iOS. For the full description of what each option does, please see - <a href="https://developer.apple.com/documentation/uikit/uimodalpresentationstyle">https://developer.apple.com/documentation/uikit/uimodalpresentationstyle</a> for more details + > + for more details
Provides the Auth0Context to its child components.
<Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"> <App /></Auth0Provider> -Copy
<Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"> <App /></Auth0Provider> -
<Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"> <App /></Auth0Provider> +Copy
<Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"> <App /></Auth0Provider> +
+ Use the useAuth0 in your function components to + access authentication state and methods. +
useAuth0
- Use the useAuth0 in your function components to - access authentication state and methods. -
The useAuth0 hook interface
const { // State error, user, isLoading, // Methods authorize, sendSMSCode, authorizeWithSMS, sendEmailCode, authorizeWithEmail, sendMultifactorChallenge, authorizeWithOOB, authorizeWithOTP, authorizeWithRecoveryCode, hasValidCredentials, clearSession, getCredentials, clearCredentials, requireLocalAuthentication, authorizeWithPasswordRealm, authorizeWithExchangeNativeSocial, revokeRefreshToken} = useAuth0(); -Copy
const { // State error, user, isLoading, // Methods authorize, sendSMSCode, authorizeWithSMS, sendEmailCode, authorizeWithEmail, sendMultifactorChallenge, authorizeWithOOB, authorizeWithOTP, authorizeWithRecoveryCode, hasValidCredentials, clearSession, getCredentials, clearCredentials, requireLocalAuthentication, authorizeWithPasswordRealm, authorizeWithExchangeNativeSocial, revokeRefreshToken} = useAuth0(); -
- Refer to <a - href="../interfaces/Types.Auth0ContextInterface.html" - class="tsd-kind-interface">Auth0ContextInterface</a> - on how to use the above methods. -
const { // State error, user, isLoading, // Methods authorize, sendSMSCode, authorizeWithSMS, sendEmailCode, authorizeWithEmail, sendMultifactorChallenge, authorizeWithOOB, authorizeWithOTP, authorizeWithRecoveryCode, hasValidCredentials, clearSession, getCredentials, clearCredentials, requireLocalAuthentication, authorizeWithPasswordRealm, authorizeWithExchangeNativeSocial, revokeRefreshToken} = useAuth0(); +Copy
const { // State error, user, isLoading, // Methods authorize, sendSMSCode, authorizeWithSMS, sendEmailCode, authorizeWithEmail, sendMultifactorChallenge, authorizeWithOOB, authorizeWithOTP, authorizeWithRecoveryCode, hasValidCredentials, clearSession, getCredentials, clearCredentials, requireLocalAuthentication, authorizeWithPasswordRealm, authorizeWithExchangeNativeSocial, revokeRefreshToken} = useAuth0(); +
+ Refer to + Auth0ContextInterface + on how to use the above methods. +
-
- 📚 Documentation • 🚀 - Getting Started • ⏭️ - Next Steps • ❓ + 📚 Documentation • 🚀 + Getting Started • ⏭️ + Next Steps • ❓ FAQs - • ❓ Feedback + • ❓ Feedback
- We're excited to announce the release of react-native-auth0 + We're excited to announce the release of react-native-auth0 v4.0.0! Please note that this update includes breaking changes that require your attention. To ensure a smooth transition, please review our 👉 @@ -149,15 +124,8 @@
v4.0.0
This SDK targets apps that are using React Native SDK version - 0.65.0 and up. If you're using an older React Native - version, see the compatibility matrix below. + 0.65.0 and up. If you're using an older React + Native version, see the compatibility matrix below.
0.65.0
The following shows platform minimums for running projects with this @@ -241,51 +190,42 @@
Our SDK requires a minimum iOS deployment target of 13.0. In your - project's ios/Podfile, ensure your platform target is set to 13.0. + project's ios/Podfile, ensure your platform target is set to + 13.0.
platform :ios, '13.0' Copy
platform :ios, '13.0'
First install the native library module:
$ npm install react-native-auth0 --save
$ yarn add react-native-auth0
@@ -293,71 +233,46 @@
$ cd ios && pod install
You need to make your Android, iOS or Expo applications aware that an authentication result will be received from the browser. This SDK - makes use of the Android's Package Name and its analogous iOS's - Product Bundle Identifier to generate the redirect URL. Each - platform has its own set of instructions. -
- > Before version 2.9.0, this SDK required you to add an intent - filter to the Activity on which you're going to receive the - authentication result, and to use the singleTask - launchMode in that activity. To migrate your app to - version 2.9.0+, remove both and continue with the - instructions below. > You can also check out a sample migration - diff - here. -
singleTask
+ + Before version 2.9.0, this SDK required you to add an intent + filter to the Activity on which you're going to receive the + authentication result, and to use the singleTask + launchMode in that activity. To migrate your app + to version 2.9.0+, remove both and continue with + the instructions below. You can also check out a sample migration + diff + here. + +
+ Before version 2.9.0, this SDK required you to add an intent + filter to the Activity on which you're going to receive the + authentication result, and to use the singleTask + launchMode in that activity. To migrate your app + to version 2.9.0+, remove both and continue with + the instructions below. You can also check out a sample migration + diff + here. +
- Open your app's build.gradle file (typically at + Open your app's build.gradle file (typically at android/app/build.gradle) and add the following manifest placeholders:
build.gradle
android/app/build.gradle
android { - defaultConfig { - // Add the next line - manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"] - } - ... -} -Copy
android { - defaultConfig { - // Add the next line - manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"] - } - ... -} -
android { defaultConfig { // Add the next line manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"] } ...} +Copy
android { defaultConfig { // Add the next line manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"] } ...} +
The auth0Domain value must be replaced with your Auth0 domain value. So if you have samples.us.auth0.com as your Auth0 domain you would have a configuration like the following:
auth0Domain
samples.us.auth0.com
android { - defaultConfig { - manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"] - } - ... -} -Copy
android { - defaultConfig { - manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"] - } - ... -} -
android { defaultConfig { manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"] } ...} +Copy
android { defaultConfig { manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"] } ...} +
The applicationId value will be auto-replaced at runtime with the package name or ID of your application (e.g. @@ -365,14 +280,16 @@
applicationId
AndroidManifest.xml
- > Note that if your Android application is using - product flavors, you might need to specify different manifest placeholders for - each flavor. -
+ + Note that if your Android application is using + product flavors, you might need to specify different manifest placeholders for + each flavor. + +
+ Note that if your Android application is using + product flavors, you might need to specify different manifest placeholders for + each flavor. +
If you use a value other than applicationId in auth0Scheme you will also need to pass it as the @@ -380,127 +297,94 @@
auth0Scheme
authorize
clearSession
- Take note of this value as you'll be requiring it to define the + Take note of this value as you'll be requiring it to define the callback URLs below.
- > For more info please read the - React Native docs. -
+ + For more info please read the + React Native docs. + +
+ For more info please read the + React Native docs. +
- If you don't plan to use Web Authentication, you will notice that - the compiler will still prompt you to provide the + If you don't plan to use Web Authentication, you will notice + that the compiler will still prompt you to provide the manifestPlaceholders values, since the RedirectActivity included in this library will require - them, and the Gradle tasks won't be able to run without them. + them, and the Gradle tasks won't be able to run without them.
manifestPlaceholders
RedirectActivity
Re-declare the activity manually with - tools:node="remove" in your app's Android + tools:node="remove" in your app's Android Manifest in order to make the manifest merger remove it from the final manifest file. Additionally, one more unused activity can be removed from the final APK by using the same process. A complete snippet to achieve this is:
tools:node="remove"
<activity - android:name="com.auth0.android.provider.AuthenticationActivity" - tools:node="remove"/> -<!-- Optional: Remove RedirectActivity --> -<activity - android:name="com.auth0.android.provider.RedirectActivity" - tools:node="remove"/> -Copy
<activity - android:name="com.auth0.android.provider.AuthenticationActivity" - tools:node="remove"/> -<!-- Optional: Remove RedirectActivity --> -<activity - android:name="com.auth0.android.provider.RedirectActivity" - tools:node="remove"/> -
<activity android:name="com.auth0.android.provider.AuthenticationActivity" tools:node="remove"/><!-- Optional: Remove RedirectActivity --><activity android:name="com.auth0.android.provider.RedirectActivity" tools:node="remove"/> +Copy
<activity android:name="com.auth0.android.provider.AuthenticationActivity" tools:node="remove"/><!-- Optional: Remove RedirectActivity --><activity android:name="com.auth0.android.provider.RedirectActivity" tools:node="remove"/> +
Inside the ios folder find the file AppDelegate.[swift|m] add the following to it:
ios
AppDelegate.[swift|m]
#import <React/RCTLinkingManager.h> - -- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url - options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options -{ - return [RCTLinkingManager application:app openURL:url options:options]; -} -Copy
#import <React/RCTLinkingManager.h> - -- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url - options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options -{ - return [RCTLinkingManager application:app openURL:url options:options]; -} -
#import <React/RCTLinkingManager.h>- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options{ return [RCTLinkingManager application:app openURL:url options:options];} +Copy
#import <React/RCTLinkingManager.h>- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options{ return [RCTLinkingManager application:app openURL:url options:options];} +
Inside the ios folder open the Info.plist and locate the value for CFBundleIdentifier, e.g.
Info.plist
CFBundleIdentifier
<key>CFBundleIdentifier</key> -<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> -Copy
<key>CFBundleIdentifier</key> -<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> -
<key>CFBundleIdentifier</key><string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> +Copy
<key>CFBundleIdentifier</key><string>$(PRODUCT_BUNDLE_IDENTIFIER)</string> +
and then below it register a URL type entry using the value of CFBundleIdentifier as the value for CFBundleURLSchemes:
CFBundleURLSchemes
<key>CFBundleURLTypes</key> -<array> - <dict> - <key>CFBundleTypeRole</key> - <string>None</string> - <key>CFBundleURLName</key> - <string>auth0</string> - <key>CFBundleURLSchemes</key> - <array> - <string>$(PRODUCT_BUNDLE_IDENTIFIER).auth0</string> - </array> - </dict> -</array> -Copy
<key>CFBundleURLTypes</key> -<array> - <dict> - <key>CFBundleTypeRole</key> - <string>None</string> - <key>CFBundleURLName</key> - <string>auth0</string> - <key>CFBundleURLSchemes</key> - <array> - <string>$(PRODUCT_BUNDLE_IDENTIFIER).auth0</string> - </array> - </dict> -</array> -
<key>CFBundleURLTypes</key><array> <dict> <key>CFBundleTypeRole</key> <string>None</string> <key>CFBundleURLName</key> <string>auth0</string> <key>CFBundleURLSchemes</key> <array> <string>$(PRODUCT_BUNDLE_IDENTIFIER).auth0</string> </array> </dict></array> +Copy
<key>CFBundleURLTypes</key><array> <dict> <key>CFBundleTypeRole</key> <string>None</string> <key>CFBundleURLName</key> <string>auth0</string> <key>CFBundleURLSchemes</key> <array> <string>$(PRODUCT_BUNDLE_IDENTIFIER).auth0</string> </array> </dict></array> +
If your application is generated using the React Native CLI, the default value of $(PRODUCT_BUNDLE_IDENTIFIER) matches org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier). Take note of this value as you'll be requiring it to define the - callback URLs below. If desired, you can change its value using + >. Take note of this value as you'll be requiring it to define + the callback URLs below. If desired, you can change its value using XCode in the following way:
$(PRODUCT_BUNDLE_IDENTIFIER)
org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier)
ios/TestApp.xcodeproj
xed ios
com.example.app
@@ -511,23 +395,24 @@
customScheme
- > :warning: This SDK is not compatible with "Expo Go" - app because of custom native code. It is compatible with Custom Dev - Client and EAS builds -
+ + :warning: This SDK is not compatible with "Expo Go" app + because of custom native code. It is compatible with Custom Dev + Client and EAS builds + +
+ :warning: This SDK is not compatible with "Expo Go" app + because of custom native code. It is compatible with Custom Dev + Client and EAS builds +
To use the SDK with Expo, configure the app at build time by providing the domain and the @@ -537,17 +422,18 @@
domain
{ "expo": { ... "plugins": [ [ "react-native-auth0", { "domain": "YOUR_AUTH0_DOMAIN", "customScheme": "YOUR_CUSTOM_SCHEME" } ] ] }} -Copy
{ "expo": { ... "plugins": [ [ "react-native-auth0", { "domain": "YOUR_AUTH0_DOMAIN", "customScheme": "YOUR_CUSTOM_SCHEME" } ] ] }} -
- > :info: If you want to switch between multiple domains in your - app, refer - here -
{ "expo": { ... "plugins": [ [ "react-native-auth0", { "domain": "YOUR_AUTH0_DOMAIN", "customScheme": "YOUR_CUSTOM_SCHEME" } ] ] }} +Copy
{ "expo": { ... "plugins": [ [ "react-native-auth0", { "domain": "YOUR_AUTH0_DOMAIN", "customScheme": "YOUR_CUSTOM_SCHEME" } ] ] }} +
+ + :info: If you want to switch between multiple domains in your app, + refer + here + +
+ :info: If you want to switch between multiple domains in your app, + refer + here +
expo run:android
expo run:ios
Callback URLs are the URLs that Auth0 invokes after the authentication process. Auth0 routes your application back to this URL and appends additional parameters to it, including a token. Since callback URLs can be manipulated, you will need to add this - URL to your Application's Allowed Callback URLs for - security. This will enable Auth0 to recognize these URLs as valid. - If omitted, authentication will not be successful. + URL to your Application's + Allowed Callback URLs for security. This will + enable Auth0 to recognize these URLs as valid. If omitted, + authentication will not be successful.
On the Android platform this URL is case-sensitive. Because of that, @@ -621,321 +501,49 @@
- > [!NOTE] > Whenever possible, Auth0 recommends using - Android App Links - and - Apple Universal Links - for your callback and logout URLs. Custom URL schemes can be subject - to - client impersonation attacks. > > 💡 If your Android app is using - product flavors, you might need to specify different manifest placeholders for - each flavor. -
{YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -Copy
{YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -
https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -Copy
https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -
- > Replace {YOUR_APP_PACKAGE_NAME} and {YOUR_AUTH0_DOMAIN} with - your actual application package name and Auth0 domain. Ensure that - {YOUR_APP_PACKAGE_NAME} is all lowercase. -
- To enable App Links, set the auth0Scheme to - https in your build.gradle file. -
https
android { - defaultConfig { - manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"] - } -} -Copy
android { - defaultConfig { - manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"] - } -} -
- This configuration ensures that your app uses https for the callback - URL scheme, which is required for Android App Links. -
- Android App Links - allow an application to designate itself as the default handler of a - given type of link. For example, clicking a URL in an email would - open the link in the designated application. This guide will show - you how to enable Android App links support for your - Auth0-registered application using Auth0's Dashboard. -
- Go to - Auth0 Dashboard > Applications > Applications, and select the name of the application to view. -
- Scroll to the bottom of the Settings page, and select - Show Advanced Settings. -
- Select Device Settings, provide the - App Package Name and - the SHA256 fingerprints of your app’s signing certificate for - your Android application, and select Save Changes. - -
- > You can use the following command to generate the fingerprint - using the Java keytool in your terminal: - keytool -list -v -keystore my-release-key.keystore -
keytool -list -v -keystore my-release-key.keystore
- To learn more about signing certificates, see Android's - Sign Your App - developer documentation. -
{PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -Copy
{PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -
https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -Copy
https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -
- > Replace {PRODUCT_BUNDLE_IDENTIFIER} and - {YOUR_AUTH0_DOMAIN} with your actual product bundle - identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER} - is all lowercase. -
{PRODUCT_BUNDLE_IDENTIFIER}
{YOUR_AUTH0_DOMAIN}
- > [!IMPORTANT] > This step requires a paid Apple Developer - account. It is needed to use Universal Links as callback and logout - URLs. > Skip this step to use a custom URL scheme instead. -
- Scroll to the end of the settings page of your Auth0 application and - open Advanced Settings > Device Settings. In the - iOS section, set Team ID to your - Apple Team ID, and App ID to your app's bundle identifier. -
- -
- This will add your app to your Auth0 tenant's - apple-app-site-association file. -
apple-app-site-association
- In Xcode, go to the Signing and Capabilities - tab - of your app's target settings, and press the - + Capability button. Then select - Associated Domains. -
- Next, add the following - entry - under Associated Domains: -
webcredentials:YOUR_AUTH0_DOMAIN -Copy
webcredentials:YOUR_AUTH0_DOMAIN -
<details> <summary>Example</summary>
- If your Auth0 Domain were example.us.auth0.com, then - this value would be: -
example.us.auth0.com
webcredentials:example.us.auth0.com -Copy
webcredentials:example.us.auth0.com -
</details>
- If you have a custom domain, replace YOUR_AUTH0_DOMAIN with your custom domain. -
YOUR_AUTH0_DOMAIN
- > [!NOTE] > For the associated domain to work, your app must - be signed with your team certificate - even when building for the iOS simulator. Make sure - you are using the Apple Team whose Team ID is configured in the - settings page of your Auth0 application. -
- Refer to the example of - Using custom scheme for web authentication redirection -
- > This SDK is OIDC compliant. To ensure OIDC compliant responses - from the Auth0 servers enable the - OIDC Conformant switch in your Auth0 dashboard - under Application / Settings / Advanced OAuth. For more - information please check - this documentation. -
Application / Settings / Advanced OAuth
{YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +Copy
{YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +
+ + Make sure to replace {YOUR_APP_PACKAGE_NAME} and {AUTH0_DOMAIN} + with the actual values for your application. The + {YOUR_APP_PACKAGE_NAME} value provided should be all lower case. + +
+ Make sure to replace {YOUR_APP_PACKAGE_NAME} and {AUTH0_DOMAIN} + with the actual values for your application. The + {YOUR_APP_PACKAGE_NAME} value provided should be all lower case. +
{PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +Copy
{PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +
+ + Make sure to replace {PRODUCT_BUNDLE_IDENTIFIER} and + {AUTH0_DOMAIN} with the actual values for your application. The + {PRODUCT_BUNDLE_IDENTIFIER} value provided should be all lower + case. + +
+ Make sure to replace {PRODUCT_BUNDLE_IDENTIFIER} and + {AUTH0_DOMAIN} with the actual values for your application. The + {PRODUCT_BUNDLE_IDENTIFIER} value provided should be all lower + case. +
+ + This SDK is OIDC compliant. To ensure OIDC compliant responses + from the Auth0 servers enable the + OIDC Conformant switch in your Auth0 dashboard + under Application / Settings / Advanced OAuth. For + more information please check + this documentation. + +
+ This SDK is OIDC compliant. To ensure OIDC compliant responses + from the Auth0 servers enable the + OIDC Conformant switch in your Auth0 dashboard + under Application / Settings / Advanced OAuth. For + more information please check + this documentation. +
The SDK exports a React hook as the primary interface for performing - web authentication through the + web authentication through the browser using Auth0 clientId values as given to you when setting up your Auth0 app in the dashboard:
clientId
import { Auth0Provider } from 'react-native-auth0';const App = () => { return ( <Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"> {/* YOUR APP */} </Auth0Provider> );};export default App; -Copy
import { Auth0Provider } from 'react-native-auth0';const App = () => { return ( <Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"> {/* YOUR APP */} </Auth0Provider> );};export default App; -
import { Auth0Provider } from 'react-native-auth0';const App = () => { return ( <Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"> {/* YOUR APP */} </Auth0Provider> );};export default App; +Copy
import { Auth0Provider } from 'react-native-auth0';const App = () => { return ( <Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"> {/* YOUR APP */} </Auth0Provider> );};export default App; +
- <details> <summary>Using the - Auth0 class</summary> -
Auth0
- If you're not using React Hooks, you can simply instantiate the - Auth0 class: -
import Auth0 from 'react-native-auth0';const auth0 = new Auth0({ domain: 'YOUR_AUTH0_DOMAIN', clientId: 'YOUR_AUTH0_CLIENT_ID',}); -Copy
import Auth0 from 'react-native-auth0';const auth0 = new Auth0({ domain: 'YOUR_AUTH0_DOMAIN', clientId: 'YOUR_AUTH0_CLIENT_ID',}); -
+ If you're not using React Hooks, you can simply instantiate + the Auth0 class: +
import Auth0 from 'react-native-auth0';const auth0 = new Auth0({ domain: 'YOUR_AUTH0_DOMAIN', clientId: 'YOUR_AUTH0_CLIENT_ID',}); +Copy
import Auth0 from 'react-native-auth0';const auth0 = new Auth0({ domain: 'YOUR_AUTH0_DOMAIN', clientId: 'YOUR_AUTH0_CLIENT_ID',}); +
Then import the hook into a component where you want to get access to the properties and methods for integrating with Auth0:
import { useAuth0 } from 'react-native-auth0'; -Copy
import { useAuth0 } from 'react-native-auth0'; -
import { useAuth0 } from 'react-native-auth0'; +Copy
import { useAuth0 } from 'react-native-auth0'; +
Use the authorize method to redirect the user to the Auth0 @@ -1012,136 +613,111 @@
error
const Component = () => { const { authorize, user, isLoading, error } = useAuth0(); const login = async () => { await authorize(); }; if (isLoading) { return ( <View> <Text>SDK is Loading</Text> </View> ); } return ( <View> {!user && <Button onPress={login} title="Log in" />} {user && <Text>Logged in as {user.name}</Text>} {error && <Text>{error.message}</Text>} </View> );}; -Copy
const Component = () => { const { authorize, user, isLoading, error } = useAuth0(); const login = async () => { await authorize(); }; if (isLoading) { return ( <View> <Text>SDK is Loading</Text> </View> ); } return ( <View> {!user && <Button onPress={login} title="Log in" />} {user && <Text>Logged in as {user.name}</Text>} {error && <Text>{error.message}</Text>} </View> );}; -
const Component = () => { const { authorize, user, isLoading, error } = useAuth0(); const login = async () => { await authorize(); }; if (isLoading) { return ( <View> <Text>SDK is Loading</Text> </View> ); } return ( <View> {!user && <Button onPress={login} title="Log in" />} {user && <Text>Logged in as {user.name}</Text>} {error && <Text>{error.message}</Text>} </View> );}; +Copy
const Component = () => { const { authorize, user, isLoading, error } = useAuth0(); const login = async () => { await authorize(); }; if (isLoading) { return ( <View> <Text>SDK is Loading</Text> </View> ); } return ( <View> {!user && <Button onPress={login} title="Log in" />} {user && <Text>Logged in as {user.name}</Text>} {error && <Text>{error.message}</Text>} </View> );}; +
auth0.webAuth .authorize() .then(credentials => console.log(credentials)) .catch(error => console.log(error)); -Copy
auth0.webAuth .authorize() .then(credentials => console.log(credentials)) .catch(error => console.log(error)); -
auth0.webAuth .authorize() .then(credentials => console.log(credentials)) .catch(error => console.log(error)); +Copy
auth0.webAuth .authorize() .then(credentials => console.log(credentials)) .catch(error => console.log(error)); +
- > Web Authentication flows require a Browser application - installed on the device. When no Browser is available, an error of - type a0.browser_not_available will be raised via the - provided callback. -
a0.browser_not_available
- Check the FAQ for more information about - the alert box that pops up by default when using - Web Auth on iOS. -
- > See also - this blog post - for a detailed overview of Single Sign-On (SSO) on iOS. -
+ + Web Authentication flows require a Browser application installed + on the device. When no Browser is available, an error of type + a0.browser_not_available will be raised via the + provided callback. + +
+ Web Authentication flows require a Browser application installed + on the device. When no Browser is available, an error of type + a0.browser_not_available will be raised via the + provided callback. +
+ Check the FAQ for more information about the + alert box that pops up by default when using Web + Auth on iOS. +
+ + See also + this blog post + for a detailed overview of Single Sign-On (SSO) on iOS. + +
+ See also + this blog post + for a detailed overview of Single Sign-On (SSO) on iOS. +
Log the user out by using the clearSession method from the useAuth0 hook.
const Component = () => { const { clearSession, user } = useAuth0(); const logout = async () => { await clearSession(); }; return <View>{user && <Button onPress={logout} title="Log out" />}</View>;}; -Copy
const Component = () => { const { clearSession, user } = useAuth0(); const logout = async () => { await clearSession(); }; return <View>{user && <Button onPress={logout} title="Log out" />}</View>;}; -
const Component = () => { const { clearSession, user } = useAuth0(); const logout = async () => { await clearSession(); }; return <View>{user && <Button onPress={logout} title="Log out" />}</View>;}; +Copy
const Component = () => { const { clearSession, user } = useAuth0(); const logout = async () => { await clearSession(); }; return <View>{user && <Button onPress={logout} title="Log out" />}</View>;}; +
auth0.webAuth.clearSession().catch((error) => console.log(error)); -Copy
auth0.webAuth.clearSession().catch((error) => console.log(error)); -
auth0.webAuth.clearSession().catch((error) => console.log(error)); +Copy
auth0.webAuth.clearSession().catch((error) => console.log(error)); +
The Credentials Manager allows you to securely store and retrieve - the user's credentials. The credentials will be stored encrypted in - Shared Preferences on Android, and in the Keychain on iOS. + the user's credentials. The credentials will be stored encrypted + in Shared Preferences on Android, and in the Keychain on iOS.
The Auth0 class exposes the credentialsManager property for you to interact with using the API below.
credentialsManager
- > 💡 If you're using Web Auth (authorize) through - Hooks, you do not need to manually store the credentials after login - and delete them after logout; the SDK does this automatically. -
+ + 💡 If you're using Web Auth (authorize) through + Hooks, you do not need to manually store the credentials after + login and delete them after logout; the SDK does this + automatically. + +
+ 💡 If you're using Web Auth (authorize) through + Hooks, you do not need to manually store the credentials after + login and delete them after logout; the SDK does this + automatically. +
When the users open your app, check for valid credentials. If they - exist, you can retrieve them and redirect the users to the app's + exist, you can retrieve them and redirect the users to the app's main flow without any additional login steps.
const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();if (isLoggedIn) { // Retrieve credentials and redirect to the main flow} else { // Redirect to the login page} -Copy
const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();if (isLoggedIn) { // Retrieve credentials and redirect to the main flow} else { // Redirect to the login page} -
const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();if (isLoggedIn) { // Retrieve credentials and redirect to the main flow} else { // Redirect to the login page} +Copy
const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();if (isLoggedIn) { // Retrieve credentials and redirect to the main flow} else { // Redirect to the login page} +
The credentials will be automatically renewed using the @@ -1150,37 +726,39 @@
const credentials = await auth0.credentialsManager.getCredentials(); -Copy
const credentials = await auth0.credentialsManager.getCredentials(); -
- > 💡 You do not need to call credentialsManager.saveCredentials() - afterward. The Credentials Manager automatically persists the - renewed credentials. -
const credentials = await auth0.credentialsManager.getCredentials(); +Copy
const credentials = await auth0.credentialsManager.getCredentials(); +
+ + 💡 You do not need to call credentialsManager.saveCredentials() + afterward. The Credentials Manager automatically persists the + renewed credentials. + +
+ 💡 You do not need to call credentialsManager.saveCredentials() + afterward. The Credentials Manager automatically persists the + renewed credentials. +
- > :warning: The requireLocalAuthentication method is - no longer available as part of the - CredentialsManager class or the - useAuth0 Hook from v4 of the SDK. -
requireLocalAuthentication
CredentialsManager
- > ℹ️ You need to use at least version 0.59.0 of - React Native, as it uses FragmentActivity as the base - activity, which is required for biometric authentication to work. -
0.59.0
FragmentActivity
+ + :warning: The requireLocalAuthentication method is no + longer available as part of the + CredentialsManager class or the + useAuth0 Hook from v4 of the SDK. + +
+ :warning: The requireLocalAuthentication method is no + longer available as part of the + CredentialsManager class or the + useAuth0 Hook from v4 of the SDK. +
+ + ℹ️ You need to use at least version 0.59.0 of React + Native, as it uses FragmentActivity as the base + activity, which is required for biometric authentication to work. + +
+ ℹ️ You need to use at least version 0.59.0 of React + Native, as it uses FragmentActivity as the base + activity, which is required for biometric authentication to work. +
You can enable an additional level of user authentication before retrieving credentials using the local authentication supported by @@ -1200,9 +778,8 @@
import Auth0 from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const auth0 = new Auth0({ domain: config.domain, clientId: config.clientId, localAuthenticationOptions: localAuthOptions,}); -Copy
import Auth0 from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const auth0 = new Auth0({ domain: config.domain, clientId: config.clientId, localAuthenticationOptions: localAuthOptions,}); -
import Auth0 from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const auth0 = new Auth0({ domain: config.domain, clientId: config.clientId, localAuthenticationOptions: localAuthOptions,}); +Copy
import Auth0 from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const auth0 = new Auth0({ domain: config.domain, clientId: config.clientId, localAuthenticationOptions: localAuthOptions,}); +
Using Hooks (Auth0Provider):
Auth0Provider now accepts a new parameter, which is an @@ -1210,12 +787,11 @@
Auth0Provider
import { Auth0Provider } from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const App = () => { return ( <Auth0Provider domain={config.domain} clientId={config.clientId} localAuthenticationOptions={localAuthOptions} > {/* YOUR APP */} </Auth0Provider> );};export default App; -Copy
import { Auth0Provider } from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const App = () => { return ( <Auth0Provider domain={config.domain} clientId={config.clientId} localAuthenticationOptions={localAuthOptions} > {/* YOUR APP */} </Auth0Provider> );};export default App; -
import { Auth0Provider } from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const App = () => { return ( <Auth0Provider domain={config.domain} clientId={config.clientId} localAuthenticationOptions={localAuthOptions} > {/* YOUR APP */} </Auth0Provider> );};export default App; +Copy
import { Auth0Provider } from 'react-native-auth0';const localAuthOptions: LocalAuthenticationOptions = { title: 'Authenticate to retreive your credentials', subtitle: 'Please authenticate to continue', description: 'We need to authenticate you to retrieve your credentials', cancelTitle: 'Cancel', evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics, fallbackTitle: 'Use Passcode', authenticationLevel: LocalAuthenticationLevel.strong, deviceCredentialFallback: true,};const App = () => { return ( <Auth0Provider domain={config.domain} clientId={config.clientId} localAuthenticationOptions={localAuthOptions} > {/* YOUR APP */} </Auth0Provider> );};export default App; +
Detailed information on LocalAuthenticationOptions is - available here + available here
LocalAuthenticationOptions
LocalAuthenticationOptions:
@@ -1289,40 +865,36 @@
- > :warning: You need a real device to test Local Authentication - for iOS. Local Authentication is not available in simulators. -
+ + :warning: You need a real device to test Local Authentication for + iOS. Local Authentication is not available in simulators. + +
+ :warning: You need a real device to test Local Authentication for + iOS. Local Authentication is not available in simulators. +
The Credentials Manager will only throw CredentialsManagerError exceptions. You can find more information in the details property of the exception.
CredentialsManagerError
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(error);} -Copy
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(error);} -
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(error);} +Copy
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(error);} +
Platform agnostic errors:
You can access the platform agnostic generic error codes as below :
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(e.type);} -Copy
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(e.type);} -
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(e.type);} +Copy
try { const credentials = await auth0.credentialsManager.getCredentials();} catch (error) { console.log(e.type);} +
Note : We have platform agnostic error codes available only for CredentialsManagerError as of now. @@ -1384,8 +956,12 @@
BIOMETRICS_FAILED
BIOMETRIC_NO_ACTIVITY
BIOMETRIC_ERROR_STATUS_UNKNOWN
BIOMETRIC_ERROR_UNSUPPORTED
BIOMETRIC_ERROR_HW_UNAVAILABLE
BIOMETRIC_ERROR_NONE_ENROLLED
BIOMETRIC_ERROR_NO_HARDWARE
BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED
BIOMETRIC_AUTHENTICATION_CHECK_FAILED
BIOMETRIC_ERROR_DEVICE_CREDENTIAL_NOT_AVAILABLE
We appreciate feedback and contribution to this repo! Before you get started, please see the following: @@ -1429,40 +991,30 @@
To provide feedback or report a bug, please raise an issue on our issue tracker.
Please do not report security vulnerabilities on the public Github @@ -1473,124 +1025,166 @@
- <p align="center"> <picture> <source - media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> <source - media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150"> <img alt="Auth0 Logo" - src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> </picture> </p> <p - align="center">Auth0 is an easy to implement, adaptable - authentication and authorization platform. To learn more checkout - <a href="https://auth0.com/why-auth0">Why Auth0?</a></p> <p - align="center"> This project is licensed under the MIT - license. See the <a href=" + + + + + +
+ Auth0 is an easy to implement, adaptable authentication and + authorization platform. To learn more checkout + Why Auth0? +
+ This project is licensed under the MIT license. See the + https://github.com/auth0/react-native-auth0/blob/master/LICENSE"> LICENSE</a> file for more info.</p> + > + LICENSE + file for more info.
<!-- Variables -->