auth0-react-ionic

This is a fork from @auth0/auth0-react to enable using auth0 in ionic+react apps. For iOS it uses ASWebauthenticationSession to handle redirection to auth0 with is the recommended way by Apple

Please make sure you have the below plugins installed in you ionic app.

@ionic-native/ios-aswebauthenticationsession-api
cordova-plugin-ios-aswebauthenticationsession-api
Any PR's most welcome.

Auth0 SDK for React Single Page Applications (SPA).


Table of Contents

- Documentation
- Installation
- Getting Started
- Contributing
- Support + Feedback
- Troubleshooting
- Frequently Asked Questions
- Vulnerability Reporting
- What is Auth0
- License

Documentation

- API Reference
- Quickstart Guide

Installation

Using npm

``bash
npm install @auth0/auth0-react
`

Using yarn

`bash
yarn add @auth0/auth0-react
`

Getting Started

Configure the SDK by wrapping your application in Auth0Provider:

`jsx
// src/index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { Auth0Provider } from '@auth0/auth0-react';
import App from './App';

ReactDOM.render(
domain="YOUR_AUTH0_DOMAIN"
clientId="YOUR_AUTH0_CLIENT_ID"
redirectUri={window.location.origin}
platform="ios" // or 'web' or 'android'. if empty sets to 'web'
>

,
document.getElementById('app')
);
`

Use the useAuth0 hook in your components to access authentication state (isLoading, isAuthenticated and user) and authentication methods (loginWithRedirect and logout):

`jsx
// src/App.js
import React from 'react';
import { useAuth0 } from '@auth0/auth0-react';

function App() {
const {
isLoading,
isAuthenticated,
error,
user,
loginWithRedirect,
logout,
} = useAuth0();

if (isLoading) {
return

;
}
if (error) {
return

Oops... {error.message}

;
}

if (isAuthenticated) {
return (

Hello {user.name}{' '}
logout({ returnTo: window.location.origin })}>
Log out

);
} else {
return Log in;
}
}

export default App;
`

If you're using TypeScript, you can pass a type parameter to useAuth0 to specify the type of user:

`ts
const { user } = useAuth0<{ name: string }>();

user.name; // is a string
`

$3

Use the withAuth0 higher order component to add the auth0 property to Class components:

`jsx
import React, { Component } from 'react';
import { withAuth0 } from '@auth0/auth0-react';

class Profile extends Component {
render() {
// this.props.auth0 has all the same properties as the useAuth0 hook
const { user } = this.props.auth0;
return

;
}
}

export default withAuth0(Profile);
`

$3

Protect a route component using the withAuthenticationRequired higher order component. Visits to this route when unauthenticated will redirect the user to the login page and back to this page after login:

`jsx
import React from 'react';
import { withAuthenticationRequired } from '@auth0/auth0-react';

const PrivateRoute = () =>

;

export default withAuthenticationRequired(PrivateRoute, {
// Show a message while the user waits to be redirected to the login page.
onRedirecting: () =>

Redirecting you to the login page...

,
});
`

Note If you are using a custom router, you will need to supply the Auth0Provider with a custom onRedirectCallback method to perform the action that returns the user to the protected page. See examples for react-router, Gatsby and Next.js.

$3

Call a protected API with an Access Token:

`jsx
import React, { useEffect, useState } from 'react';
import { useAuth0 } from '@auth0/auth0-react';

const Posts = () => {
const { getAccessTokenSilently } = useAuth0();
const [posts, setPosts] = useState(null);

useEffect(() => {
(async () => {
try {
const token = await getAccessTokenSilently({
audience: 'https://api.example.com/',
scope: 'read:posts',
});
const response = await fetch('https://api.example.com/posts', {
headers: {
Authorization: Bearer ${token},
},
});
setPosts(await response.json());
} catch (e) {
console.error(e);
}
})();
}, [getAccessTokenSilently]);

if (!posts) {
return

;
}

return (

{posts.map((post, index) => {
return
• {post}
;
})}

);
};

export default Posts;
`

For a more detailed example see how to create a useApi` hook for accessing protected APIs with an access token.

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

- Auth0's general contribution guidelines
- Auth0's code of conduct guidelines
- This repo's contribution guide

Support + Feedback

For support or to provide feedback, please raise an issue on our issue tracker.

Troubleshooting

For information on how to solve common problems, check out the Troubleshooting guide

Frequently Asked Questions

For a rundown of common issues you might encounter when using the SDK, please check out the FAQ.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

What is Auth0?

Auth0 helps you to easily:

- Implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
- Log in users with username/password databases, passwordless, or multi-factor authentication
- Link multiple user accounts together
- Generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
- Access demographics and analytics detailing how, when, and where users are logging in
- Enrich user profiles from other data sources using customizable JavaScript rules

Why Auth0?

License

This project is licensed under the MIT license. See the LICENSE file for more info.