Unlike web authentication, we do not provide a hook for integrating with the Authentication API.
Instantiate the Auth0 class to get access to the methods that call Auth0's Authentication API endpoints:
import Auth0 from 'react-native-auth0';
const auth0 = new Auth0({
domain: 'YOUR_AUTH0_DOMAIN',
clientId: 'YOUR_AUTH0_CLIENT_ID',
});auth0.auth
.passwordRealm({
username: '[email protected]',
password: 'password',
realm: 'myconnection',
})
.then(console.log)
.catch(console.error);auth0.auth
.userInfo({ token: 'the user access_token' })
.then(console.log)
.catch(console.error);This endpoint requires an access token that was granted the /userinfo audience. Check that the authentication request that returned the access token included an audience value of https://{YOUR_AUTH0_DOMAIN}.auth0.com/userinfo.
auth0.auth
.refreshToken({ refreshToken: 'the user refresh_token' })
.then(console.log)
.catch(console.error);Custom Schemes can be used for redirecting to the React Native application after web authentication:
authorize({}, { customScheme: 'auth0' }).then(console.log).catch(console.error);This call requires the client to have the MFA Client Grant Type enabled. Check this article to learn how to enable it.
When you sign in to a multifactor authentication enabled connection using the passwordRealm method, you receive an error stating that MFA is required for that user along with an mfa_token value. Use this value to call loginWithOTP and complete the MFA flow passing the One Time Password from the enrolled MFA code generator app.
auth0.auth
.loginWithOTP({
mfaToken: error.json.mfa_token,
otp: '{user entered OTP}',
})
.then(console.log)
.catch(console.error);Passwordless is a two-step authentication flow that makes use of this type of connection. The Passwordless OTP grant is required to be enabled in your Auth0 application beforehand. Check our guide to learn how to enable it.
To start the flow, you request a code to be sent to the user's email or phone number. For email scenarios only, a link can be sent in place of the code.
auth0.auth
.passwordlessWithEmail({
email: '[email protected]',
send: 'link',
})
.then(console.log)
.catch(console.error);or
auth0.auth
.passwordlessWithSMS({
phoneNumber: '+5491159991000',
})
.then(console.log)
.catch(console.error);Then, in order to complete the authentication, you must send back that received code value along with the email or phone number used:
auth0.auth
.loginWithEmail({
email: '[email protected]',
code: '123456',
})
.then(console.log)
.catch(console.error);or
auth0.auth
.loginWithSMS({
phoneNumber: '+5491159991000',
code: '123456',
})
.then(console.log)
.catch(console.error);auth0.auth
.createUser({
email: '[email protected]',
username: 'username',
password: 'password',
connection: 'myconnection',
})
.then(console.log)
.catch(console.error);auth0
.users('the user access_token')
.patchUser({
id: 'user_id',
metadata: { first_name: 'John', last_name: 'Doe' },
})
.then(console.log)
.catch(console.error);auth0
.users('{ACCESS_TOKEN}')
.getUser({ id: 'user_id' })
.then(console.log)
.catch(console.error);For more info please check our generated documentation
Organizations is a set of features that provide better support for developers who build and maintain SaaS and Business-to-Business (B2B) applications.
Using Organizations, you can: Note that Organizations is currently only available to customers on our Enterprise and Startup subscription plans.
auth0.webAuth
.authorize({ organization: 'organization-id' })
.then((credentials) => console.log(credentials))
.catch((error) => console.log(error));Users can be invited to your organization via a link. Tapping on the invitation link should open your app. Since invitations links are https only, is recommended that your Android app supports Android App Links. In the case of iOS, your app must support Universal Links.
In Enable Android App Links Support and Enable Universal Links Support, you will find how to make the Auth0 server publish the Digital Asset Links file required by your applications.
When your app gets opened by an invitation link, grab the invitation URL and pass it as a parameter to the webauth call. Use the Linking Module method called getInitialUrl() to obtain the URL that launched your application.
auth0.webAuth
.authorize({
invitationUrl:
'https://myapp.com/login?invitation=inv123&organization=org123',
})
.then((credentials) => console.log(credentials))
.catch((error) => console.log(error));If the URL doesn't contain the expected values, an error will be raised through the provided callback.
If you are using the Bot Protection feature and performing database login/signup via the Authentication API, you need to handle the requires_verification error. It indicates that the request was flagged as suspicious and an additional verification step is necessary to log the user in. That verification step is web-based, so you need to use Universal Login to complete it.
const email = '[email protected]';
const realm = 'Username-Password-Authentication';
const scope = 'openid profile';
auth0.auth
.passwordRealm({
username: email,
password: 'secret-password',
realm: realm,
scope: scope,
})
.then((credentials) => {
// Logged in!
})
.catch((error) => {
if (error.name === 'requires_verification') {
auth0.webAuth
.authorize({
connection: realm,
scope: scope,
login_hint: email, // So the user doesn't have to type it again
})
.then((credentials) => {
// Logged in!
})
.catch(console.error);
} else {
console.error(error);
}
});In the case of signup, you can add an additional parameter to make the user land directly on the signup page:
auth0.webAuth.authorize({
connection: realm,
scope: scope,
login_hint: email,
screen_hint: 'signup', // 👈🏻
});