+
+
+If you have a [custom domain](https://auth0.com/docs/customize/custom-domains), replace `YOUR_AUTH0_DOMAIN` with your custom 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](https://github.com/auth0/react-native-auth0/blob/master/EXAMPLES.md#using-custom-scheme-for-web-authentication-redirection)
+
+## Next Steps
+
+> 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](https://auth0.com/docs/api-auth/intro#how-to-use-the-new-flows).
+
+### Web Authentication
+
+The SDK exports a React hook as the primary interface for performing [web authentication](#web-authentication) through the browser using Auth0 [Universal Login](https://auth0.com/docs/authenticate/login/auth0-universal-login).
+
+Use the methods from the `useAuth0` hook to implement login, logout, and to retrieve details about the authenticated user.
+
+See the [API Documentation](https://auth0.github.io/react-native-auth0/functions/useAuth0.html) for full details on the `useAuth0` hook.
+
+First, import the `Auth0Provider` component and wrap it around your application. Provide the `domain` and `clientId` values as given to you when setting up your Auth0 app in the dashboard:
+
+```js
+import { Auth0Provider } from 'react-native-auth0';
+
+const App = () => {
+ return (
+ Example
+ +If your Auth0 Domain were `example.us.auth0.com`, then this value would be: + +```text +webcredentials:example.us.auth0.com +``` + +
+
+
+Then import the hook into a component where you want to get access to the properties and methods for integrating with Auth0:
+
+```js
+import { useAuth0 } from 'react-native-auth0';
+```
+
+#### Login
+
+Use the `authorize` method to redirect the user to the Auth0 [Universal Login](https://auth0.com/docs/authenticate/login/auth0-universal-login) page for authentication. If `scope` is not specified, `openid profile email` is used by default.
+
+- The `isLoading` property is set to true once the authentication state of the user is known to the SDK.
+- The `user` property is populated with details about the authenticated user. If `user` is `null`, no user is currently authenticated.
+- The `error` property is populated if any error occurs.
+
+```js
+const Component = () => {
+ const { authorize, user, isLoading, error } = useAuth0();
+
+ const login = async () => {
+ await authorize();
+ };
+
+ if (isLoading) {
+ return (
+ Using the `Auth0` class
+ +If you're not using React Hooks, you can simply instantiate the `Auth0` class: + +```js +import Auth0 from 'react-native-auth0'; + +const auth0 = new Auth0({ + domain: 'YOUR_AUTH0_DOMAIN', + clientId: 'YOUR_AUTH0_CLIENT_ID', +}); +``` + +
+
+
+> 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.
+
+##### SSO Alert Box (iOS)
+
+
+
+Check the [FAQ](_media/FAQ.md) for more information about the alert box that pops up **by default** when using Web Auth on iOS.
+
+> See also [this blog post](https://developer.okta.com/blog/2022/01/13/mobile-sso) for a detailed overview of Single Sign-On (SSO) on iOS.
+
+#### Logout
+
+Log the user out by using the `clearSession` method from the `useAuth0` hook.
+
+```js
+const Component = () => {
+ const { clearSession, user } = useAuth0();
+
+ const logout = async () => {
+ await clearSession();
+ };
+
+ return Using the `Auth0` class
+ + ```js + auth0.webAuth + .authorize() + .then(credentials => console.log(credentials)) + .catch(error => console.log(error)); + ``` +
+
+
+### Credentials Manager
+
+- [Check for stored credentials](#check-for-stored-credentials)
+- [Retrieve stored credentials](#retrieve-stored-credentials)
+- [Local authentication](#local-authentication)
+- [Credentials Manager errors](#credentials-manager-errors)
+
+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 `Auth0` class exposes the `credentialsManager` property for you to interact with using the API below.
+
+> 💡 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.
+
+#### Check for stored credentials
+
+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 main flow without any additional login steps.
+
+```js
+const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();
+
+if (isLoggedIn) {
+ // Retrieve credentials and redirect to the main flow
+} else {
+ // Redirect to the login page
+}
+```
+
+#### Retrieve stored credentials
+
+The credentials will be automatically renewed using the [refresh token](https://auth0.com/docs/secure/tokens/refresh-tokens), if the access token has expired. **This method is thread safe**.
+
+```js
+const credentials = await auth0.credentialsManager.getCredentials();
+```
+
+> 💡 You do not need to call credentialsManager.saveCredentials() afterward. The Credentials Manager automatically persists the renewed credentials.
+
+#### Requiring Authentication before obtaining Credentials
+
+> :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 can enable an additional level of user authentication before retrieving credentials using the local authentication supported by the device, for example PIN or fingerprint on Android, and Face ID or Touch ID on iOS.
+
+Refer to the instructions below to understand how to enable authentication before retrieving credentials based on your setup:
+
+**Using Auth0 Class:**
+
+The `Auth0` class constructor now accepts a new parameter, which is an instance of the `LocalAuthenticationOptions` object. This needs to be passed while creating an instance of `Auth0` to enable authentication before obtaining credentials, as shown in the code snippet below:
+
+```tsx
+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 instance of the `LocalAuthenticationOptions` object. This needs to be passed to enable authentication before obtaining credentials, as shown in the code snippet below:
+
+```tsx
+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 (
+ Using the `Auth0` class
+ +```js +auth0.webAuth.clearSession().catch((error) => console.log(error)); +``` + +`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` | `biometricsFailed` | +| `NO_NETWORK` | `NO_NETWORK` | | +| `API_ERROR` | `API_ERROR` | | + +## Feedback + +### Contributing + +We appreciate feedback and contribution to this repo! Before you get started, please see the following: + +- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) +- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) +- [This repo's development guide](DEVELOPMENT.md) + +### Raise an issue + +To provide feedback or report a bug, [please raise an issue on our issue tracker](https://github.com/auth0/react-native-auth0/issues). + +### Vulnerability Reporting + +Please do not report security vulnerabilities on the public Github issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. + +--- + +
+ 
+
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 LICENSE file for more info.
+ + + +[npm-image]: https://img.shields.io/npm/v/react-native-auth0.svg?style=flat-square +[npm-url]: https://npmjs.org/package/react-native-auth0 +[circleci-image]: https://img.shields.io/circleci/project/github/auth0/react-native-auth0.svg?branch=master&style=flat-square +[circleci-url]: https://circleci.com/gh/auth0/react-native-auth0 +[codecov-image]: https://img.shields.io/codecov/c/github/auth0/react-native-auth0.svg?style=flat-square +[codecov-url]: https://codecov.io/github/auth0/react-native-auth0 +[license-image]: https://img.shields.io/npm/l/react-native-auth0.svg?style=flat-square +[license-url]: #license +[downloads-image]: https://img.shields.io/npm/dm/react-native-auth0.svg?style=flat-square +[downloads-url]: https://npmjs.org/package/react-native-auth0 diff --git a/docs/Types/README.md b/docs/Types/README.md new file mode 100644 index 00000000..07b90966 --- /dev/null +++ b/docs/Types/README.md @@ -0,0 +1,25 @@ +[**react-native-auth0**](../README.md) + +--- + +[react-native-auth0](../globals.md) / Types + +# Types + +## Classes + +- [Auth](classes/Auth.md) +- [BaseError](classes/BaseError.md) +- [CredentialsManager](classes/CredentialsManager.md) +- [Users](classes/Users.md) +- [WebAuth](classes/WebAuth.md) + +## Interfaces + +- [Auth0ContextInterface](interfaces/Auth0ContextInterface.md) +- [AuthState](interfaces/AuthState.md) + +## Type Aliases + +- [Auth0Response](type-aliases/Auth0Response.md) +- [Telemetry](type-aliases/Telemetry.md) diff --git a/docs/Types/classes/Auth.md b/docs/Types/classes/Auth.md new file mode 100644 index 00000000..ff7d9d39 --- /dev/null +++ b/docs/Types/classes/Auth.md @@ -0,0 +1,463 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / Auth + +# Class: Auth + +Defined in: [auth/index.ts:65](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L65) + +Class for interfacing with the Auth0 Authentication API endpoints. + +## See + +https://auth0.com/docs/api/authentication + +## Properties + +### clientId + +> `readonly` **clientId**: `string` + +Defined in: [auth/index.ts:70](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L70) + +The Auth0 client ID + +--- + +### domain + +> `readonly` **domain**: `string` + +Defined in: [auth/index.ts:74](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L74) + +The Auth0 tenant domain + +## Methods + +### authorizeUrl() + +> **authorizeUrl**(`parameters`): `string` + +Defined in: [auth/index.ts:104](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L104) + +Builds the full authorize endpoint url in the Authorization Server (AS) with given parameters. + +#### Parameters + +##### parameters + +[`AuthorizeUrlOptions`](../../interfaces/AuthorizeUrlOptions.md) + +#### Returns + +`string` + +A URL to the authorize endpoint with specified parameters to redirect to for AuthZ/AuthN. + +#### See + +https://auth0.com/docs/api/authentication#authorize-client + +--- + +### createUser() + +> **createUser**(`parameters`): `Promise`\<`Partial`\<[`User`](../../type-aliases/User.md)\>\> + +Defined in: [auth/index.ts:585](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L585) + +Creates a new user using the options provided. + +#### Parameters + +##### parameters + +[`CreateUserOptions`](../../interfaces/CreateUserOptions.md) + +#### Returns + +`Promise`\<`Partial`\<[`User`](../../type-aliases/User.md)\>\> + +An instance of [User](../../type-aliases/User.md). + +--- + +### exchange() + +> **exchange**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:149](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L149) + +Exchanges a code obtained via `/authorize` (w/PKCE) for the user's tokens + +#### Parameters + +##### parameters + +[`ExchangeOptions`](../../interfaces/ExchangeOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A prominse for a populated instance of [Credentials](../../type-aliases/Credentials.md). + +#### See + +https://auth0.com/docs/api-auth/grant/authorization-code-pkce + +--- + +### exchangeNativeSocial() + +> **exchangeNativeSocial**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:179](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L179) + +Exchanges an external token obtained via a native social authentication solution for the user's tokens + +#### Parameters + +##### parameters + +[`ExchangeNativeSocialOptions`](../../interfaces/ExchangeNativeSocialOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +#### See + +https://auth0.com/docs/api/authentication#token-exchange-for-native-social + +--- + +### loginWithEmail() + +> **loginWithEmail**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:305](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L305) + +Completes the Passworldess authentication with an email connection that was started using [passwordlessWithEmail](#passwordlesswithemail). + +#### Parameters + +##### parameters + +[`LoginWithEmailOptions`](../../interfaces/LoginWithEmailOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### loginWithOOB() + +> **loginWithOOB**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:406](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L406) + +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](https://auth0.com/docs/clients/client-grant-types) to learn how to enable it. + +#### Parameters + +##### parameters + +[`LoginWithOOBOptions`](../../interfaces/LoginWithOOBOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### loginWithOTP() + +> **loginWithOTP**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:373](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L373) + +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](https://auth0.com/docs/clients/client-grant-types) to learn how to enable it. + +#### Parameters + +##### parameters + +[`LoginWithOTPOptions`](../../interfaces/LoginWithOTPOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### loginWithRecoveryCode() + +> **loginWithRecoveryCode**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:440](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L440) + +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](https://auth0.com/docs/clients/client-grant-types) to learn how to enable it. + +#### Parameters + +##### parameters + +[`LoginWithRecoveryCodeOptions`](../../interfaces/LoginWithRecoveryCodeOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### loginWithSMS() + +> **loginWithSMS**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:337](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L337) + +Completes the Passworldess authentication with an SMS connection that was started using [passwordlessWithSMS](#passwordlesswithsms). + +#### Parameters + +##### parameters + +[`LoginWithSMSOptions`](../../interfaces/LoginWithSMSOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### logoutUrl() + +> **logoutUrl**(`parameters`): `string` + +Defined in: [auth/index.ts:129](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L129) + +Builds the full logout endpoint url in the Authorization Server (AS) with given parameters. + +#### Parameters + +##### parameters + +[`LogoutUrlOptions`](../../interfaces/LogoutUrlOptions.md) + +#### Returns + +`string` + +A URL to the logout endpoint with specified parameters + +#### See + +https://auth0.com/docs/api/authentication#logout + +--- + +### multifactorChallenge() + +> **multifactorChallenge**(`parameters`): `Promise`\<[`MultifactorChallengeResponse`](../../type-aliases/MultifactorChallengeResponse.md)\> + +Defined in: [auth/index.ts:474](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L474) + +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". + +#### Parameters + +##### parameters + +[`MultifactorChallengeOptions`](../../interfaces/MultifactorChallengeOptions.md) + +#### Returns + +`Promise`\<[`MultifactorChallengeResponse`](../../type-aliases/MultifactorChallengeResponse.md)\> + +[MultifactorChallengeOTPResponse](../../type-aliases/MultifactorChallengeOTPResponse.md), [MultifactorChallengeOOBResponse](../../type-aliases/MultifactorChallengeOOBResponse.md), or [MultifactorChallengeOOBWithBindingResponse](../../type-aliases/MultifactorChallengeOOBWithBindingResponse.md) depending +on the challenge type. + +--- + +### passwordlessWithEmail() + +> **passwordlessWithEmail**(`parameters`): `Promise`\<`void`\> + +Defined in: [auth/index.ts:262](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L262) + +Starts the Passworldess flow with an email connection. + +This should be completed later using a call to [loginWithEmail](#loginwithemail), passing the OTP that was sent to the user. + +#### Parameters + +##### parameters + +[`PasswordlessWithEmailOptions`](../../interfaces/PasswordlessWithEmailOptions.md) + +#### Returns + +`Promise`\<`void`\> + +--- + +### passwordlessWithSMS() + +> **passwordlessWithSMS**(`parameters`): `Promise`\<`void`\> + +Defined in: [auth/index.ts:279](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L279) + +Starts the Passwordless flow with an SMS connection. + +This should be completed later using a call to [loginWithSMS](#loginwithsms), passing the OTP that was sent to the user. + +#### Parameters + +##### parameters + +[`PasswordlessWithSMSOptions`](../../interfaces/PasswordlessWithSMSOptions.md) + +#### Returns + +`Promise`\<`void`\> + +--- + +### passwordRealm() + +> **passwordRealm**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:213](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L213) + +Performs Auth with user credentials using the Password Realm Grant + +#### Parameters + +##### parameters + +[`PasswordRealmOptions`](../../interfaces/PasswordRealmOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +#### See + +https://auth0.com/docs/api-auth/grant/password#realm-support + +--- + +### refreshToken() + +> **refreshToken**(`parameters`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [auth/index.ts:233](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L233) + +Obtain new tokens using the Refresh Token obtained during Auth (requesting `offline_access` scope) + +#### Parameters + +##### parameters + +[`RefreshTokenOptions`](../../interfaces/RefreshTokenOptions.md) + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +#### See + +https://auth0.com/docs/tokens/refresh-token/current#use-a-refresh-token + +--- + +### resetPassword() + +> **resetPassword**(`parameters`): `Promise`\<`void`\> + +Defined in: [auth/index.ts:566](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L566) + +Request an email with instructions to change password of a user + +#### Parameters + +##### parameters + +[`ResetPasswordOptions`](../../interfaces/ResetPasswordOptions.md) + +#### Returns + +`Promise`\<`void`\> + +--- + +### revoke() + +> **revoke**(`parameters`): `Promise`\<`void`\> + +Defined in: [auth/index.ts:503](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L503) + +Revoke an issued refresh token + +#### Parameters + +##### parameters + +[`RevokeOptions`](../../interfaces/RevokeOptions.md) + +#### Returns + +`Promise`\<`void`\> + +--- + +### userInfo() + +> **userInfo**(`parameters`): `Promise`\<[`User`](../../type-aliases/User.md)\> + +Defined in: [auth/index.ts:530](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth/index.ts#L530) + +Return user information using an access token + +#### Parameters + +##### parameters + +[`UserInfoOptions`](../../interfaces/UserInfoOptions.md) + +#### Returns + +`Promise`\<[`User`](../../type-aliases/User.md)\> + +The user's profile information. diff --git a/docs/Types/classes/BaseError.md b/docs/Types/classes/BaseError.md new file mode 100644 index 00000000..b4368bea --- /dev/null +++ b/docs/Types/classes/BaseError.md @@ -0,0 +1,55 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / BaseError + +# Class: BaseError + +Defined in: [utils/baseError.ts:1](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/baseError.ts#L1) + +## Extends + +- `Error` + +## Extended by + +- [`TimeoutError`](../../classes/TimeoutError.md) + +## Constructors + +### Constructor + +> **new BaseError**(`name`, `message`, `type?`): `BaseError` + +Defined in: [utils/baseError.ts:3](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/baseError.ts#L3) + +#### Parameters + +##### name + +`string` + +##### message + +`string` + +##### type? + +`string` + +#### Returns + +`BaseError` + +#### Overrides + +`Error.constructor` + +## Properties + +### type + +> **type**: `string` + +Defined in: [utils/baseError.ts:2](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/baseError.ts#L2) diff --git a/docs/Types/classes/CredentialsManager.md b/docs/Types/classes/CredentialsManager.md new file mode 100644 index 00000000..8a126b64 --- /dev/null +++ b/docs/Types/classes/CredentialsManager.md @@ -0,0 +1,109 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / CredentialsManager + +# Class: CredentialsManager + +Defined in: [credentials-manager/index.ts:8](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/index.ts#L8) + +## Methods + +### clearCredentials() + +> **clearCredentials**(): `Promise`\<`void`\> + +Defined in: [credentials-manager/index.ts:123](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/index.ts#L123) + +Delete the stored credentials + +#### Returns + +`Promise`\<`void`\> + +--- + +### getCredentials() + +> **getCredentials**(`scope?`, `minTtl?`, `parameters?`, `forceRefresh?`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [credentials-manager/index.ts:70](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/index.ts#L70) + +Gets the credentials that has already been saved + +#### Parameters + +##### scope? + +`string` + +The scope to request for the access token. If null is passed, the previous scope will be kept. + +##### minTtl? + +`number` = `0` + +The minimum time in seconds that the access token should last before expiration. + +##### parameters? + +`Record`\<`string`, `unknown`\> = `{}` + +Additional parameters to send in the request to refresh expired credentials. + +##### forceRefresh? + +`boolean` = `false` + +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 + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A populated instance of [Credentials](../../type-aliases/Credentials.md). + +--- + +### hasValidCredentials() + +> **hasValidCredentials**(`minTtl`): `Promise`\<`boolean`\> + +Defined in: [credentials-manager/index.ts:110](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/index.ts#L110) + +Returns whether this manager contains a valid non-expired pair of credentials. + +#### Parameters + +##### minTtl + +`number` = `0` + +The minimum time in seconds that the access token should last before expiration + +#### Returns + +`Promise`\<`boolean`\> + +`true` if a valid set of credentials are available, or `false` if there are no credentials to return. + +--- + +### saveCredentials() + +> **saveCredentials**(`credentials`): `Promise`\<`void`\> + +Defined in: [credentials-manager/index.ts:31](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/index.ts#L31) + +Saves the provided credentials + +#### Parameters + +##### credentials + +[`Credentials`](../../type-aliases/Credentials.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/Types/classes/Users.md b/docs/Types/classes/Users.md new file mode 100644 index 00000000..923d25c8 --- /dev/null +++ b/docs/Types/classes/Users.md @@ -0,0 +1,78 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / Users + +# Class: Users + +Defined in: [management/users.ts:39](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/management/users.ts#L39) + +Auth0 Management API User endpoints + +## Export + +## See + +https://auth0.com/docs/api/management/v2#!/Users/ +Users + +## Methods + +### getUser() + +> **getUser**(`parameters`): `Promise`\<[`User`](../../type-aliases/User.md)\> + +Defined in: [management/users.ts:67](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/management/users.ts#L67) + +Returns the user by identifier + +#### Parameters + +##### parameters + +[`GetUserOptions`](../../interfaces/GetUserOptions.md) + +get user by identifier parameters + +#### Returns + +`Promise`\<[`User`](../../type-aliases/User.md)\> + +#### See + +https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id + +#### Memberof + +Users + +--- + +### patchUser() + +> **patchUser**(`parameters`): `Promise`\<[`User`](../../type-aliases/User.md)\> + +Defined in: [management/users.ts:90](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/management/users.ts#L90) + +Patch a user's `user_metadata` + +#### Parameters + +##### parameters + +[`PatchUserOptions`](../../interfaces/PatchUserOptions.md) + +patch user metadata parameters + +#### Returns + +`Promise`\<[`User`](../../type-aliases/User.md)\> + +#### See + +https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id + +#### Memberof + +Users diff --git a/docs/Types/classes/WebAuth.md b/docs/Types/classes/WebAuth.md new file mode 100644 index 00000000..fea70ee0 --- /dev/null +++ b/docs/Types/classes/WebAuth.md @@ -0,0 +1,95 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / WebAuth + +# Class: WebAuth + +Defined in: [webauth/index.ts:24](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/webauth/index.ts#L24) + +Helper to perform Auth against Auth0 hosted login page + +It will use `/authorize` endpoint of the Authorization Server (AS) +with Code Grant and Proof Key for Challenge Exchange (PKCE). + +## See + +https://auth0.com/docs/api-auth/grant/authorization-code-pkce + +## Methods + +### authorize() + +> **authorize**(`parameters`, `options`): `Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +Defined in: [webauth/index.ts:53](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/webauth/index.ts#L53) + +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 + +#### Parameters + +##### parameters + +[`WebAuthorizeParameters`](../../interfaces/WebAuthorizeParameters.md) = `{}` + +##### options + +[`WebAuthorizeOptions`](../../interfaces/WebAuthorizeOptions.md) = `{}` + +#### Returns + +`Promise`\<[`Credentials`](../../type-aliases/Credentials.md)\> + +A poplulated instance of [Credentials](../../type-aliases/Credentials.md). + +#### See + +https://auth0.com/docs/api/authentication#authorize-client + +--- + +### cancelWebAuth() + +> **cancelWebAuth**(): `Promise`\<`void`\> + +Defined in: [webauth/index.ts:79](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/webauth/index.ts#L79) + +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. + +#### Returns + +`Promise`\<`void`\> + +--- + +### clearSession() + +> **clearSession**(`parameters`, `options`): `Promise`\<`void`\> + +Defined in: [webauth/index.ts:92](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/webauth/index.ts#L92) + +Removes Auth0 session and optionally remove the Identity Provider session. + +#### Parameters + +##### parameters + +[`ClearSessionParameters`](../../interfaces/ClearSessionParameters.md) = `{}` + +##### options + +[`ClearSessionOptions`](../../interfaces/ClearSessionOptions.md) = `{}` + +#### Returns + +`Promise`\<`void`\> + +#### See + +https://auth0.com/docs/logout diff --git a/docs/Types/interfaces/Auth0ContextInterface.md b/docs/Types/interfaces/Auth0ContextInterface.md new file mode 100644 index 00000000..6f1f71a1 --- /dev/null +++ b/docs/Types/interfaces/Auth0ContextInterface.md @@ -0,0 +1,451 @@ +[**react-native-auth0**](../../README.md) + +--- + +[react-native-auth0](../../globals.md) / [Types](../README.md) / Auth0ContextInterface + +# Interface: Auth0ContextInterface\
-
-
-
-
-
diff --git a/docs/classes/TimeoutError.md b/docs/classes/TimeoutError.md
new file mode 100644
index 00000000..bd48b9b3
--- /dev/null
+++ b/docs/classes/TimeoutError.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / TimeoutError
+
+# Class: TimeoutError
+
+Defined in: [utils/fetchWithTimeout.ts:3](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/fetchWithTimeout.ts#L3)
+
+## Extends
+
+- [`BaseError`](../Types/classes/BaseError.md)
+
+## Constructors
+
+### Constructor
+
+> **new TimeoutError**(`msg`): `TimeoutError`
+
+Defined in: [utils/fetchWithTimeout.ts:4](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/fetchWithTimeout.ts#L4)
+
+#### Parameters
+
+##### msg
+
+`string`
+
+#### Returns
+
+`TimeoutError`
+
+#### Overrides
+
+[`BaseError`](../Types/classes/BaseError.md).[`constructor`](../Types/classes/BaseError.md#constructor)
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+Defined in: [utils/baseError.ts:2](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/utils/baseError.ts#L2)
+
+#### Inherited from
+
+[`BaseError`](../Types/classes/BaseError.md).[`type`](../Types/classes/BaseError.md#type)
diff --git a/docs/classes/Types.Auth.html b/docs/classes/Types.Auth.html
deleted file mode 100644
index 922d9acb..00000000
--- a/docs/classes/Types.Auth.html
+++ /dev/null
@@ -1,2237 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Class TimeoutError
-- Hierarchy (view full) -
--
-
-
- BaseError
-
-
-
- TimeoutError -
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
- Constructors
-
- constructor
-
- Properties
-
- type
-
- Constructors
-- constructor -
--
-
-
- new
Timeout Error(msg): TimeoutError -
- -
- --
Parameters
--
-
- - msg: - string - -
- Returns - TimeoutError -
- -
-
Properties
-- type -
-
- type:
- string
-
-
-
-
-
-
-
-
diff --git a/docs/classes/Types.BaseError.html b/docs/classes/Types.BaseError.html
deleted file mode 100644
index 669a2329..00000000
--- a/docs/classes/Types.BaseError.html
+++ /dev/null
@@ -1,438 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- authorize
-
-
-
-
- create
-
-
-
-
-
-
-
- exchange
-
-
-
-
- login
-
-
-
-
- login
-
-
-
-
- login
-
-
-
-
- login
-
-
-
-
- login
-
-
-
-
- logout
-
-
-
-
- multifactor
-
-
-
-
- password
-
-
-
-
- passwordless
-
-
-
-
- passwordless
-
-
-
-
- refresh
-
-
-
-
- reset
-
-
-
-
-
-
-
- user
-
-
-
-
-
-
-
- Class Auth
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
- Properties
- -Methods
- -Properties
-
- Private
- client
-
-
- client:
- Client
-
-
-
- Readonly
- client
-
- client
-
-
-
-
- The Auth0 client ID
-
- Readonly
- domain
-
-
- domain:
- string
-
-
-
-
-
- The Auth0 tenant domain
-Methods
-
- authorize
- -
-
-
- authorize
Url(parameters): string -
- -
- --
- Builds the full authorize endpoint url in the Authorization - Server (AS) with given parameters. -
---Parameters
--
-
- - parameters: - AuthorizeUrlOptions - -
- Returns string -
-- A URL to the authorize endpoint with specified parameters to - redirect to for AuthZ/AuthN. -
- - -
-
- create
- -
-
-
- create
User(parameters): Promise<Partial<User>> -
- -
- --
Creates a new user using the options provided.
---Parameters
--
-
- - parameters: - CreateUserOptions - -
- Returns Promise<Partial<User>> -
-- An instance of - User. -
- - -
-
- exchange -
--
-
- - exchange(parameters): Promise<Credentials> - -
-
- --
- Exchanges a code obtained via -
-/authorize(w/PKCE) for the user's tokens ---Parameters
--
-
- - parameters: - ExchangeOptions - -
- Returns Promise<Credentials> -
-- A prominse for a populated instance of - Credentials. -
- - -
-
- exchange
- -
-
-
- exchange
Native Social(parameters): Promise<Credentials> -
- -
- --
- Exchanges an external token obtained via a native social - authentication solution for the user's tokens -
---Parameters
--
-
- - parameters: - ExchangeNativeSocialOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- login
- -
-
-
- login
With Email(parameters): Promise<Credentials> -
- -
- --
- Completes the Passworldess authentication with an email - connection that was started using - passwordlessWithEmail. -
---Parameters
--
-
- - parameters: - LoginWithEmailOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- login
- -
-
-
- login
WithOOB(parameters): Promise<Credentials> -
- -
- --
- 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. -
---Parameters
--
-
- - parameters: - LoginWithOOBOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- login
- -
-
-
- login
WithOTP(parameters): Promise<Credentials> -
- -
- --
- 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. -
---Parameters
--
-
- - parameters: - LoginWithOTPOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- login
- -
-
-
- login
With Recovery Code(parameters): Promise<Credentials> -
- -
- --
- 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. -
---Parameters
--
-
- - parameters: - LoginWithRecoveryCodeOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- login
- -
-
-
- login
WithSMS(parameters): Promise<Credentials> -
- -
- --
- Completes the Passworldess authentication with an SMS - connection that was started using - passwordlessWithSMS. -
---Parameters
--
-
- - parameters: - LoginWithSMSOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- logout
- -
-
-
- logout
Url(parameters): string -
- -
- --
- Builds the full logout endpoint url in the Authorization - Server (AS) with given parameters. -
---Parameters
--
-
- - parameters: - LogoutUrlOptions - -
- Returns string -
-A URL to the logout endpoint with specified parameters
--- -See
- -
-
- multifactor
- -
-
-
- multifactor
Challenge(parameters): 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". -
---Parameters
--
-
- - parameters: - MultifactorChallengeOptions - -
- Returns Promise<MultifactorChallengeResponse> -
-- MultifactorChallengeOTPResponse, - MultifactorChallengeOOBResponse, or - MultifactorChallengeOOBWithBindingResponse - depending on the challenge type. -
- - -
-
- password
- -
-
-
- password
Realm(parameters): Promise<Credentials> -
- -
- --
- Performs Auth with user credentials using the Password Realm - Grant -
---Parameters
--
-
- - parameters: - PasswordRealmOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- passwordless
- -
-
-
- passwordless
With Email(parameters): Promise<void> -
- -
- --
Starts the Passworldess flow with an email connection.
-- This should be completed later using a call to - loginWithEmail, passing the OTP that was sent to the user. -
---Parameters
--
-
- - parameters: - PasswordlessWithEmailOptions - -
- Returns Promise<void> -
- - -
-
- passwordless
- -
-
-
- passwordless
WithSMS(parameters): Promise<void> -
- -
- --
Starts the Passwordless flow with an SMS connection.
-- This should be completed later using a call to - loginWithSMS, passing the OTP that was sent to the user. -
---Parameters
--
-
- - parameters: - PasswordlessWithSMSOptions - -
- Returns Promise<void> -
- - -
-
- refresh
- -
-
-
- refresh
Token(parameters): Promise<Credentials> -
- -
- --
- Obtain new tokens using the Refresh Token obtained during - Auth (requesting
-offline_accessscope) ---Parameters
--
-
- - parameters: - RefreshTokenOptions - -
- Returns Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
-
- reset
- -
-
-
- reset
Password(parameters): Promise<void> -
- -
- --
- Request an email with instructions to change password of a - user -
---Parameters
--
-
- - parameters: - ResetPasswordOptions - -
- Returns Promise<void> -
- - -
-
- revoke -
--
-
- - revoke(parameters): Promise<void> - -
-
- --
Revoke an issued refresh token
---Parameters
--
-
- - parameters: - RevokeOptions - -
- Returns Promise<void> -
- - -
-
- user
- -
-
-
- user
Info(parameters): Promise<User> -
- -
- --
Return user information using an access token
---Parameters
--
-
- - parameters: - UserInfoOptions - -
- Returns Promise<User> -
-The user's profile information.
- - -
-
-
-
-
-
-
diff --git a/docs/classes/Types.CredentialsManager.html b/docs/classes/Types.CredentialsManager.html
deleted file mode 100644
index 4b80b143..00000000
--- a/docs/classes/Types.CredentialsManager.html
+++ /dev/null
@@ -1,866 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Class BaseError
-- Hierarchy (view full) -
--
-
-
- Error
-
-
-
-
- BaseError
-
-
-
- - TimeoutError - -
-
- -
- BaseError
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
- Constructors
-
- constructor
-
- Properties
-
- type
-
- Constructors
-- constructor -
- -Properties
-- type -
-
- type:
- string
-
-
-
-
-
-
-
-
diff --git a/docs/classes/Types.Users.html b/docs/classes/Types.Users.html
deleted file mode 100644
index 16f8b2e8..00000000
--- a/docs/classes/Types.Users.html
+++ /dev/null
@@ -1,534 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- clear
-
-
-
-
-
- get
-
-
-
-
- has
-
-
-
-
- save
-
-
-
-
-
-
-
-
- Class CredentialsManager
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
- Properties
- -Methods
- -Properties
-
- Private
- Auth0
-
- Auth0
-
-
- Private
- client
-
- client
-
-
- Private
- domain
-
-
- domain:
- string
-
-
-
- Private
- Optional
- local
-
-
- Methods
-
- clear
-
-
- get
- -
-
-
- get
Credentials(scope?, - minTtl?, - parameters?, - forceRefresh?): Promise<Credentials> -
- -
- --
Gets the credentials that has already been saved
---Parameters
--
-
-
-
Optional- scope: - string --- -- The scope to request for the access token. If null is - passed, the previous scope will be kept. -
-
- -
- minTtl:
- number = 0
- -- -
- The minimum time in seconds that the access token - should last before expiration. -
-
- -
- parameters:
- Record<string, unknown> = {}
- -- -
- Additional parameters to send in the request to - refresh expired credentials. -
-
- -
- forceRefresh:
- boolean
- = false
- -- -
- 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 Promise<Credentials> -
-- A populated instance of - Credentials. -
- - -
- -
-
- has
- -
-
-
- has
Valid Credentials(minTtl?): Promise<boolean> -
- -
- --
- Returns whether this manager contains a valid non-expired - pair of credentials. -
---Parameters
--
-
-
- minTtl:
- number = 0
- -- -
- The minimum time in seconds that the access token - should last before expiration -
-
-
- Returns Promise<boolean> -
--
- - -trueif a valid set of credentials are available, - orfalseif there are no credentials to return. -
- -
- minTtl:
- number = 0
-
- save
- -
-
-
- save
Credentials(credentials): Promise<void> -
- -
- --
Saves the provided credentials
---Parameters
--
-
- - credentials: - Credentials - -
- Returns Promise<void> -
- - -
-
-
-
-
-
-
diff --git a/docs/classes/Types.WebAuth.html b/docs/classes/Types.WebAuth.html
deleted file mode 100644
index 0ef012a7..00000000
--- a/docs/classes/Types.WebAuth.html
+++ /dev/null
@@ -1,772 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- get
-
-
-
-
- patch
-
-
-
-
-
-
-
- Class Users
-
-
-
- Auth0 Management API User endpoints
-Properties
-
- Private
- client
-
-
- client:
- Client
-
-
- Methods
-
- get
- -
-
-
- get
User(parameters): Promise<User> -
- -
- --
Returns the user by identifier
---Parameters
--
-
-
- parameters:
- GetUserOptions
- -- -
get user by identifier parameters
-
-
- Returns Promise<User> -
- - -
- -
- parameters:
- GetUserOptions
-
- patch
- -
-
-
- patch
User(parameters): Promise<User> -
- -
- --
Patch a user's
-user_metadata--Parameters
--
-
-
- parameters:
- PatchUserOptions
- -- -
patch user metadata parameters
-
-
- Returns Promise<User> -
- - -
- -
- parameters:
- PatchUserOptions
-
-
-
-
-
-
diff --git a/docs/classes/default.html b/docs/classes/default.html
deleted file mode 100644
index ce71029b..00000000
--- a/docs/classes/default.html
+++ /dev/null
@@ -1,853 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- cancel
-
-
-
-
- clear
-
-
-
-
-
-
-
- Class WebAuth
-
-
-
- Helper to perform Auth against Auth0 hosted login page
-
- It will use /authorize endpoint of the Authorization
- Server (AS) with Code Grant and Proof Key for Challenge Exchange
- (PKCE).
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
-
-
- Properties
- -Methods
- -Properties
-
- Private
- agent
-
-
- agent:
- Agent
-
-
-
- Private
- client
-
- client
-
-
- Private
- domain
-
-
- domain:
- string
-
-
-
- Private
- Optional
- local
-
-
- Methods
-- authorize -
--
-
- - authorize(parameters?, - options?): 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 -
---Parameters
--
-
- - parameters: - WebAuthorizeParameters = {} - -
- - options: - WebAuthorizeOptions = {} - -
- Returns Promise<Credentials> -
-- A poplulated instance of - Credentials. -
- - -
-
- cancel
- -
-
-
- cancel
Web Auth(): Promise<void> -
- -
- --
- 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. -
-- Returns Promise<void> -
- - -
-
- clear
- -
-
-
- clear
Session(parameters?, - options?): Promise<void> -
- -
- --
- Removes Auth0 session and optionally remove the Identity - Provider session. -
---Parameters
--
-
- - parameters: - ClearSessionParameters = {} - -
- - options: - ClearSessionOptions = {} - -
- Returns Promise<void> -
--- -See
- -
-
-
-
-
-
-
diff --git a/docs/classes/default.md b/docs/classes/default.md
new file mode 100644
index 00000000..566df77e
--- /dev/null
+++ b/docs/classes/default.md
@@ -0,0 +1,113 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / default
+
+# Class: default
+
+Defined in: [auth0.ts:12](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L12)
+
+Auth0 for React Native client
+
+## Constructors
+
+### Constructor
+
+> **new default**(`options`): `Auth0`
+
+Defined in: [auth0.ts:28](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L28)
+
+Creates an instance of Auth0.
+
+#### Parameters
+
+##### options
+
+Your Auth0 application information
+
+###### clientId
+
+`string`
+
+Your Auth0 application client identifier
+
+###### domain
+
+`string`
+
+Your Auth0 domain
+
+###### localAuthenticationOptions?
+
+[`LocalAuthenticationOptions`](../interfaces/LocalAuthenticationOptions.md)
+
+The options for configuring the display of local authentication prompt, authentication level (Android only) and evaluation policy (iOS only).
+
+###### telemetry?
+
+[`Telemetry`](../Types/type-aliases/Telemetry.md)
+
+The telemetry information to be sent along with the requests
+
+###### timeout?
+
+`number`
+
+Timeout to be set for requests.
+
+###### token?
+
+`string`
+
+Token to be used for Management APIs
+
+#### Returns
+
+`Auth0`
+
+## Properties
+
+### auth
+
+> **auth**: [`Auth`](../Types/classes/Auth.md)
+
+Defined in: [auth0.ts:13](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L13)
+
+---
+
+### credentialsManager
+
+> **credentialsManager**: [`CredentialsManager`](../Types/classes/CredentialsManager.md)
+
+Defined in: [auth0.ts:15](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L15)
+
+---
+
+### webAuth
+
+> **webAuth**: [`WebAuth`](../Types/classes/WebAuth.md)
+
+Defined in: [auth0.ts:14](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L14)
+
+## Methods
+
+### users()
+
+> **users**(`token`): [`Users`](../Types/classes/Users.md)
+
+Defined in: [auth0.ts:55](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/auth0.ts#L55)
+
+Creates a Users API client
+
+#### Parameters
+
+##### token
+
+`string`
+
+for Management API
+
+#### Returns
+
+[`Users`](../Types/classes/Users.md)
diff --git a/docs/enumerations/LocalAuthenticationLevel.md b/docs/enumerations/LocalAuthenticationLevel.md
new file mode 100644
index 00000000..efde4578
--- /dev/null
+++ b/docs/enumerations/LocalAuthenticationLevel.md
@@ -0,0 +1,41 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LocalAuthenticationLevel
+
+# Enumeration: LocalAuthenticationLevel
+
+Defined in: [credentials-manager/localAuthenticationLevel.ts:5](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationLevel.ts#L5)
+
+**Used for Android only:** The level of local authentication required to access the credentials. Defaults to LocalAuthenticationLevel.strong.
+
+## Enumeration Members
+
+### deviceCredential
+
+> **deviceCredential**: `2`
+
+Defined in: [credentials-manager/localAuthenticationLevel.ts:17](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationLevel.ts#L17)
+
+The non-biometric credential used to secure the device (i. e. PIN, pattern, or password).
+
+---
+
+### strong
+
+> **strong**: `0`
+
+Defined in: [credentials-manager/localAuthenticationLevel.ts:9](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationLevel.ts#L9)
+
+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.
+
+---
+
+### weak
+
+> **weak**: `1`
+
+Defined in: [credentials-manager/localAuthenticationLevel.ts:13](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationLevel.ts#L13)
+
+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.
diff --git a/docs/enumerations/LocalAuthenticationStrategy.md b/docs/enumerations/LocalAuthenticationStrategy.md
new file mode 100644
index 00000000..2607031a
--- /dev/null
+++ b/docs/enumerations/LocalAuthenticationStrategy.md
@@ -0,0 +1,31 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LocalAuthenticationStrategy
+
+# Enumeration: LocalAuthenticationStrategy
+
+Defined in: [credentials-manager/localAuthenticationStrategy.ts:4](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationStrategy.ts#L4)
+
+**Used for iOS only:** The evaluation policy to use when accessing the credentials. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics.
+
+## Enumeration Members
+
+### deviceOwner
+
+> **deviceOwner**: `2`
+
+Defined in: [credentials-manager/localAuthenticationStrategy.ts:12](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationStrategy.ts#L12)
+
+User authentication with biometry, Apple Watch, or the device passcode.
+
+---
+
+### deviceOwnerWithBiometrics
+
+> **deviceOwnerWithBiometrics**: `1`
+
+Defined in: [credentials-manager/localAuthenticationStrategy.ts:8](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationStrategy.ts#L8)
+
+User authentication with biometry.
diff --git a/docs/enumerations/SafariViewControllerPresentationStyle.md b/docs/enumerations/SafariViewControllerPresentationStyle.md
new file mode 100644
index 00000000..38b8be22
--- /dev/null
+++ b/docs/enumerations/SafariViewControllerPresentationStyle.md
@@ -0,0 +1,92 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / SafariViewControllerPresentationStyle
+
+# Enumeration: SafariViewControllerPresentationStyle
+
+Defined in: [types.ts:601](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L601)
+
+Presentation styles for when using SFSafariViewController on iOS.
+For the full description of what each option does, please see [https://developer.apple.com/documentation/uikit/uimodalpresentationstyle](https://developer.apple.com/documentation/uikit/uimodalpresentationstyle) for more details
+
+## Enumeration Members
+
+### automatic
+
+> **automatic**: `-2`
+
+Defined in: [types.ts:602](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L602)
+
+---
+
+### currentContext
+
+> **currentContext**: `3`
+
+Defined in: [types.ts:607](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L607)
+
+---
+
+### custom
+
+> **custom**: `4`
+
+Defined in: [types.ts:608](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L608)
+
+---
+
+### formSheet
+
+> **formSheet**: `2`
+
+Defined in: [types.ts:606](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L606)
+
+---
+
+### fullScreen
+
+> **fullScreen**: `0`
+
+Defined in: [types.ts:604](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L604)
+
+---
+
+### none
+
+> **none**: `-1`
+
+Defined in: [types.ts:603](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L603)
+
+---
+
+### overCurrentContext
+
+> **overCurrentContext**: `6`
+
+Defined in: [types.ts:610](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L610)
+
+---
+
+### overFullScreen
+
+> **overFullScreen**: `5`
+
+Defined in: [types.ts:609](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L609)
+
+---
+
+### pageSheet
+
+> **pageSheet**: `1`
+
+Defined in: [types.ts:605](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L605)
+
+---
+
+### popover
+
+> **popover**: `7`
+
+Defined in: [types.ts:611](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L611)
diff --git a/docs/enums/LocalAuthenticationLevel.html b/docs/enums/LocalAuthenticationLevel.html
deleted file mode 100644
index 0b43994b..00000000
--- a/docs/enums/LocalAuthenticationLevel.html
+++ /dev/null
@@ -1,424 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- credentials
-
-
-
-
-
-
-
-
-
-
-
- web
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Class default
-
-
-
- Auth0 for React Native client
-
-
-
-
-
-
-
-
- Index
-
-
-
- Constructors
-- constructor -
--
-
- - new default(options): default - -
-
- --
Creates an instance of Auth0.
---Parameters
--
-
-
- options:
- {
clientId: string;
domain: string;
localAuthenticationOptions?: LocalAuthenticationOptions;
telemetry?: Telemetry;
timeout?: number;
token?: string;
} --- -Your Auth0 application information
--
-
-
-
- client
-Id: string - -- -Your Auth0 application client identifier
-
- -
-
- domain: string -
--- -Your Auth0 domain
-
- -
-
-
-Optional- localAuthentication Options?: LocalAuthenticationOptions - -- -- The options for configuring the display of local - authentication prompt, authentication level - (Android only) and evaluation policy (iOS only). -
-
- -
-
-
-Optional- telemetry?: Telemetry --- -- The telemetry information to be sent along with - the requests -
-
- -
-
-
-Optional- timeout?: number --- -Timeout to be set for requests.
-
- -
-
-
-Optional- token?: string --- -Token to be used for Management APIs
-
-
- -
-
- Returns - default -
- - -
- -
- options:
- {
Properties
-- auth -
- - -
- credentials
-
-
-
- Private
- options
-
-
- options:
- {
clientId: string;
domain: string;
localAuthenticationOptions?: LocalAuthenticationOptions;
telemetry?: Telemetry;
timeout?: number;
token?: string;
} -
- clientId: string;
domain: string;
localAuthenticationOptions?: LocalAuthenticationOptions;
telemetry?: Telemetry;
timeout?: number;
token?: string;
} -
-
-
- Type declaration
--
-
-
-
- client
-Id: string -
- -
-
- domain: string -
-
- -
-
-
-Optional- localAuthentication Options?: LocalAuthenticationOptions -
- -
-
-
-Optional- telemetry?: Telemetry -
- -
-
-
-Optional- timeout?: number -
- -
-
-
-Optional- token?: string -
-
- web
-
-
- Methods
-- users -
- -
-
-
-
-
-
diff --git a/docs/enums/LocalAuthenticationStrategy.html b/docs/enums/LocalAuthenticationStrategy.html
deleted file mode 100644
index f7706915..00000000
--- a/docs/enums/LocalAuthenticationStrategy.html
+++ /dev/null
@@ -1,381 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- device
-
-
-
-
-
-
-
-
-
-
-
-
-
- Enumeration LocalAuthenticationLevel
-
-
-
- - Used for Android only: The level of local - authentication required to access the credentials. Defaults to - LocalAuthenticationLevel.strong. -
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Enumeration Members
- -Enumeration Members
-
- device
-
- device
-
-
-
-
- - The non-biometric credential used to secure the device (i. e. - PIN, pattern, or password). -
-- strong -
-
- strong:
- 0
-
-
-
-
-
- - 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. -
-- weak -
-
- weak:
- 1
-
-
-
-
-
- - 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. -
-
-
-
-
-
-
diff --git a/docs/enums/SafariViewControllerPresentationStyle.html b/docs/enums/SafariViewControllerPresentationStyle.html
deleted file mode 100644
index 997f398a..00000000
--- a/docs/enums/SafariViewControllerPresentationStyle.html
+++ /dev/null
@@ -1,684 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- device
-
-
-
-
- device
-
-
-
-
-
-
-
- Enumeration LocalAuthenticationStrategy
-
-
-
- - Used for iOS only: The evaluation policy to use - when accessing the credentials. Defaults to - LocalAuthenticationStrategy.deviceOwnerWithBiometrics. -
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Enumeration Members
- -Enumeration Members
-
- device
-
- device
-
-
-
-
- - User authentication with biometry, Apple Watch, or the device - passcode. -
-
- device
-
- device
-
-
-
-
- User authentication with biometry.
-
-
-
-
-
-
diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html
deleted file mode 100644
index 4fc3baaf..00000000
--- a/docs/functions/Auth0Provider.html
+++ /dev/null
@@ -1,443 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- current
-
-
-
-
-
-
-
- form
-
-
-
-
- full
-
-
-
-
-
-
-
- over
-
-
-
-
- over
-
-
-
-
- page
-
-
-
-
-
-
-
-
-
-
- Enumeration SafariViewControllerPresentationStyle
-
-
-
- - Presentation styles for when using SFSafariViewController on iOS. - For the full description of what each option does, please see - https://developer.apple.com/documentation/uikit/uimodalpresentationstyle - for more details -
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Enumeration Members
-
- automatic
- current
- Enumeration Members
-- automatic -
-
- automatic:
- -2
-
-
-
- current
-
- current
-
- - custom -
-
- custom:
- 4
-
-
-
- form
-
- form
-
-
- full
-
- full
-
- - none -
-
- none:
- -1
-
-
-
- over
-
- over
-
-
- over
-
- over
-
-
- page
-
- page
-
- - popover -
-
- popover:
- 7
-
-
-
-
-
-
-
-
diff --git a/docs/functions/Auth0Provider.md b/docs/functions/Auth0Provider.md
new file mode 100644
index 00000000..cc92dcd7
--- /dev/null
+++ b/docs/functions/Auth0Provider.md
@@ -0,0 +1,31 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / Auth0Provider
+
+# Function: Auth0Provider()
+
+> **Auth0Provider**(`__namedParameters`): `Element`
+
+Defined in: [hooks/auth0-provider.tsx:74](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/hooks/auth0-provider.tsx#L74)
+
+Provides the Auth0Context to its child components.
+
+## Parameters
+
+### \_\_namedParameters
+
+`PropsWithChildren`\<\{ `clientId`: `string`; `domain`: `string`; `localAuthenticationOptions`: [`LocalAuthenticationOptions`](../interfaces/LocalAuthenticationOptions.md); `timeout`: `number`; \}\>
+
+## Returns
+
+`Element`
+
+## Example
+
+```ts
+
-
-
-
-
-
-
-
-
-
-
- prop
-
-
-
-
-
-
-
- Function Auth0Provider
--
-
-
- Auth0
Provider(__namedParameters): Element -
- -
- --
Provides the Auth0Context to its child components.
---Parameters
--
-
-
- __namedParameters:
- PropsWithChildren<{
clientId: string;
domain: string;
localAuthenticationOptions?: LocalAuthenticationOptions;
}> -
-
- Returns Element -
--- -Example
-
-<Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID">
<App />
</Auth0Provider> -
- -
- __namedParameters:
- PropsWithChildren<{
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- prop
- Properties
-
- prop
-
- prop
children: Validator<ReactElementLike>;
clientId: Validator<string>;
domain: Validator<string>;
} -
- children: Validator<ReactElementLike>;
clientId: Validator<string>;
domain: Validator<string>;
} -
-
-
- Type declaration
--
-
-
-
- children: Validator<ReactElementLike> -
-
- -
-
- client
-Id: Validator<string> -
- -
-
- domain: Validator<string> -
-
-
-
-
-
-
-
diff --git a/docs/functions/useAuth0.md b/docs/functions/useAuth0.md
new file mode 100644
index 00000000..71980f42
--- /dev/null
+++ b/docs/functions/useAuth0.md
@@ -0,0 +1,48 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / useAuth0
+
+# Function: useAuth0()
+
+> **useAuth0**(): [`Auth0ContextInterface`](../Types/interfaces/Auth0ContextInterface.md)\<[`User`](../type-aliases/User.md)\>
+
+Defined in: [hooks/use-auth0.ts:38](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/hooks/use-auth0.ts#L38)
+
+Use the `useAuth0` in your function components to access authentication state and methods.
+
+## Returns
+
+[`Auth0ContextInterface`](../Types/interfaces/Auth0ContextInterface.md)\<[`User`](../type-aliases/User.md)\>
+
+The useAuth0 hook interface
+
+```ts
+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](../Types/interfaces/Auth0ContextInterface.md) on how to use the above methods.
diff --git a/docs/globals.md b/docs/globals.md
new file mode 100644
index 00000000..67683c63
--- /dev/null
+++ b/docs/globals.md
@@ -0,0 +1,62 @@
+[**react-native-auth0**](README.md)
+
+---
+
+# react-native-auth0
+
+## Modules
+
+- [Types](Types/README.md)
+
+## Enumerations
+
+- [LocalAuthenticationLevel](enumerations/LocalAuthenticationLevel.md)
+- [LocalAuthenticationStrategy](enumerations/LocalAuthenticationStrategy.md)
+- [SafariViewControllerPresentationStyle](enumerations/SafariViewControllerPresentationStyle.md)
+
+## Classes
+
+- [default](classes/default.md)
+- [TimeoutError](classes/TimeoutError.md)
+
+## Interfaces
+
+- [AuthorizeUrlOptions](interfaces/AuthorizeUrlOptions.md)
+- [ClearSessionOptions](interfaces/ClearSessionOptions.md)
+- [ClearSessionParameters](interfaces/ClearSessionParameters.md)
+- [CreateUserOptions](interfaces/CreateUserOptions.md)
+- [ExchangeNativeSocialOptions](interfaces/ExchangeNativeSocialOptions.md)
+- [ExchangeOptions](interfaces/ExchangeOptions.md)
+- [GetUserOptions](interfaces/GetUserOptions.md)
+- [LocalAuthenticationOptions](interfaces/LocalAuthenticationOptions.md)
+- [LoginWithEmailOptions](interfaces/LoginWithEmailOptions.md)
+- [LoginWithOOBOptions](interfaces/LoginWithOOBOptions.md)
+- [LoginWithOTPOptions](interfaces/LoginWithOTPOptions.md)
+- [LoginWithRecoveryCodeOptions](interfaces/LoginWithRecoveryCodeOptions.md)
+- [LoginWithSMSOptions](interfaces/LoginWithSMSOptions.md)
+- [LogoutUrlOptions](interfaces/LogoutUrlOptions.md)
+- [MultifactorChallengeOptions](interfaces/MultifactorChallengeOptions.md)
+- [PasswordlessWithEmailOptions](interfaces/PasswordlessWithEmailOptions.md)
+- [PasswordlessWithSMSOptions](interfaces/PasswordlessWithSMSOptions.md)
+- [PasswordRealmOptions](interfaces/PasswordRealmOptions.md)
+- [PatchUserOptions](interfaces/PatchUserOptions.md)
+- [RefreshTokenOptions](interfaces/RefreshTokenOptions.md)
+- [ResetPasswordOptions](interfaces/ResetPasswordOptions.md)
+- [RevokeOptions](interfaces/RevokeOptions.md)
+- [UserInfoOptions](interfaces/UserInfoOptions.md)
+- [WebAuthorizeOptions](interfaces/WebAuthorizeOptions.md)
+- [WebAuthorizeParameters](interfaces/WebAuthorizeParameters.md)
+
+## Type Aliases
+
+- [Credentials](type-aliases/Credentials.md)
+- [MultifactorChallengeOOBResponse](type-aliases/MultifactorChallengeOOBResponse.md)
+- [MultifactorChallengeOOBWithBindingResponse](type-aliases/MultifactorChallengeOOBWithBindingResponse.md)
+- [MultifactorChallengeOTPResponse](type-aliases/MultifactorChallengeOTPResponse.md)
+- [MultifactorChallengeResponse](type-aliases/MultifactorChallengeResponse.md)
+- [User](type-aliases/User.md)
+
+## Functions
+
+- [Auth0Provider](functions/Auth0Provider.md)
+- [useAuth0](functions/useAuth0.md)
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
deleted file mode 100644
index 2e82cacc..00000000
--- a/docs/hierarchy.html
+++ /dev/null
@@ -1,258 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
- Function useAuth0
--
-
-
- use
Auth0(): Auth0ContextInterface<User> -
- -
- --
- Use the
-useAuth0in your function components to - access authentication state and methods. -- Returns - Auth0ContextInterface<User> -
-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(); -- Refer to - Auth0ContextInterface - on how to use the above methods. -
- - -
-
-
-
-
-
-
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index a7198081..00000000
--- a/docs/index.html
+++ /dev/null
@@ -1,1388 +0,0 @@
-
-
-
-
-
-
-
-
-
- react-native-auth0
Class Hierarchy
--
-
-
- AuthState
-
-
-
-
- Auth0ContextInterface
-
- -
- Auth0ContextInterface
-
-
-
-
- BaseError
-
-
-
-
- TimeoutError
-
- -
- TimeoutError
-
-
-
-
-
-
diff --git a/docs/interfaces/AuthorizeUrlOptions.html b/docs/interfaces/AuthorizeUrlOptions.html
deleted file mode 100644
index e85fc830..00000000
--- a/docs/interfaces/AuthorizeUrlOptions.html
+++ /dev/null
@@ -1,457 +0,0 @@
-
-
-
-
-
-
-
-
-
- react-native-auth0
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- 
-
- 
- 
- 
- 
- 
- 
-
- 📚 Documentation • 🚀 - Getting Started • ⏭️ - Next Steps • ❓ - FAQs - • ❓ Feedback -
- -- ⚠️ Important Migration Notice: v4.0.0 -
-
- 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 👉
- Migration Guide
- 👈 for detailed instructions on updating your integration.
-
Documentation
--
-
- - Quickstart - -
- - Expo Quickstart - -
- - Sample App - -
- - Expo Sample App - -
- - FAQs - -
- - Examples - -
- - Docs Site - -
Getting Started
- -Requirements
-
- 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.
-
- Platform compatibility -
-- The following shows platform minimums for running projects with this - SDK: -
-| Platform | -Minimum version | -
|---|---|
| iOS | -13.0 | -
| Android | -34 | -
- 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. -
-platform :ios, '13.0'
-Installation
-First install the native library module:
- -- With npm -
-$ npm install react-native-auth0 --save
- With Yarn -
-$ yarn add react-native-auth0
- Then, you need to run the following command to install the ios app - pods with Cocoapods. That will auto-link the iOS library: -
-$ cd ios && pod install
Configure the SDK
-- 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. -
- -Android
---- 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
- android/app/build.gradle) and add the following
- manifest placeholders:
-
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:
-
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.
- com.example.app). You can change this value from the
- build.gradle file. You can also check it at the top of
- your AndroidManifest.xml file.
-
--- 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
- customScheme option parameter of the
- authorize and clearSession methods.
-
- 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. -
-
- Skipping the Web Authentication setup -
-
- 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.
-
- Re-declare the activity manually with
- 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:
-
<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"/>
-iOS
-
- Inside the ios folder find the file
- AppDelegate.[swift|m] add the following to it:
-
#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.
-
<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:
-
<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
- XCode in the following way:
-
-
-
-
- Open the
ios/TestApp.xcodeprojfile replacing - 'TestApp' with the name of your app or run -xed iosfrom a Terminal. -
- - - Open your project's or desired target's - Build Settings tab and on the search bar at the - right type "Product Bundle Identifier". - -
-
- Replace the Product Bundle Identifier value with
- your desired application's bundle identifier name (e.g.
-
com.example.app). -
- - - If you've changed the project wide settings, make sure the - same were applied to each of the targets your app has. - -
- If you use a value other than
- $(PRODUCT_BUNDLE_IDENTIFIER) in the
- CFBundleURLSchemes field of the
- Info.plist you will also need to pass it as the
- customScheme option parameter of the
- authorize and clearSession methods.
-
-- -- For more info please read the - React Native docs. -
-
Expo
---- :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
- customScheme values through the
- Config Plugin. To do this, add the following snippet to app.json or
- app.config.js:
-
{
"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 -
-
| API | -Description | -
|---|---|
| domain | -- Mandatory: Provide the Auth0 domain that can be found at the - Application Settings - | -
| customScheme | -
- Optional: Custom scheme to build the callback URL with. The
- value provided here should be passed to the
- customScheme option parameter of the
- authorize and clearSession methods.
- The custom scheme should be a unique, all lowercase value with
- no special characters.
- |
-
- Now you can run the application using
- expo run:android or expo run:ios.
-
Callback URL(s)
-- 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. -
-- On the Android platform this URL is case-sensitive. Because of that, - this SDK will auto convert the Bundle Identifier (iOS) and - Application ID (Android) values to lowercase in order to build the - Callback URL with them. If any of these values contains uppercase - characters a warning message will be printed in the console. Make - sure to check that the right Callback URL is whitelisted in the - Auth0 dashboard or the browser will not route successfully back to - your application. -
-- Go to the - Auth0 Dashboard, select your application and make sure that - Allowed Callback URLs contains the URLs defined - below. -
-- If in addition you plan to use the log out method, you must also add - these URLs to the Allowed Logout URLs. -
- -Android
-{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. -
-
iOS
-{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. -
-
Next Steps
--- -- 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. -
Web Authentication
-- The SDK exports a React hook as the primary interface for performing - web authentication through the - browser using Auth0 - Universal Login. -
-
- Use the methods from the useAuth0 hook to implement
- login, logout, and to retrieve details about the authenticated user.
-
- See the
- API Documentation
- for full details on the useAuth0 hook.
-
- First, import the Auth0Provider component and wrap it
- around your application. Provide the domain and
- clientId values as given to you when setting up your
- Auth0 app in the dashboard:
-
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;
-
-
-
- Using the `Auth0` class
- -
- 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',
});
-- 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';
-Login
-
- Use the authorize method to redirect the user to the
- Auth0
- Universal Login
- page for authentication. If scope is not specified,
- openid profile email is used by default.
-
-
-
-
- The
isLoadingproperty is set to true once the - authentication state of the user is known to the SDK. -
- -
- The
userproperty is populated with details about the - authenticated user. Ifuserisnull, no - user is currently authenticated. -
- -
- The
errorproperty is populated if any error occurs. -
-
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>
);
};
-
-
-
- Using the `Auth0` class
- -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_availablewill be raised via the - provided callback. -
SSO Alert Box (iOS)
-
- 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. -
-
Logout
-
- 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>;
};
-
-
-
-
- Using the `Auth0` class
- -auth0.webAuth.clearSession().catch((error) => console.log(error));
-Credentials Manager
--
-
- - Check for stored credentials - -
- - Retrieve stored credentials - -
- Local authentication -
- - Credentials Manager errors - -
- 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 Auth0 class exposes the
- credentialsManager property for you to interact with
- using the API below.
-
-- -- 💡 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. -
- Check for stored credentials -
-- 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 - 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
}
-- Retrieve stored credentials -
-- The credentials will be automatically renewed using the - refresh token, if the access token has expired. - This method is thread safe. -
-const credentials = await auth0.credentialsManager.getCredentials();
--- -- 💡 You do not need to call credentialsManager.saveCredentials() - afterward. The Credentials Manager automatically persists the - renewed credentials. -
-
- Requiring Authentication before obtaining Credentials -
---- :warning: The
-requireLocalAuthenticationmethod is no - longer available as part of the -CredentialsManagerclass or the -useAuth0Hook from v4 of the SDK. -
--- ℹ️ You need to use at least version
-0.59.0of React - Native, as it usesFragmentActivityas 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 - the device, for example PIN or fingerprint on Android, and Face ID - or Touch ID on iOS. -
-- Refer to the instructions below to understand how to enable - authentication before retrieving credentials based on your setup: -
-Using Auth0 Class:
-
- The Auth0 class constructor now accepts a new
- parameter, which is an instance of the
- LocalAuthenticationOptions object. This needs to be
- passed while creating an instance of Auth0 to enable
- authentication before obtaining credentials, as shown in the code
- snippet below:
-
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
- instance of the LocalAuthenticationOptions object. This
- needs to be passed to enable authentication before obtaining
- credentials, as shown in the code snippet below:
-
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
-
LocalAuthenticationOptions:
-- The options for configuring the display of local authentication - prompt, authentication level (Android only), and evaluation policy - (iOS only). -
-Properties:
-| Property | -Type | -Description | -Applicable Platforms | -
|---|---|---|---|
title |
- String |
- The title of the authentication prompt. | -Android, iOS | -
subtitle |
- String (optional) |
- The subtitle of the authentication prompt. | -Android | -
description |
- String (optional) |
- The description of the authentication prompt. | -Android | -
cancelTitle |
- String (optional) |
- The cancel button title of the authentication prompt. | -Android, iOS | -
evaluationPolicy |
- LocalAuthenticationStrategy (optional) |
-
- The evaluation policy to use when prompting the user for
- authentication. Defaults to
- deviceOwnerWithBiometrics.
- |
- iOS | -
fallbackTitle |
- String (optional) |
- The fallback button title of the authentication prompt. | -iOS | -
authenticationLevel |
- LocalAuthenticationLevel (optional) |
-
- The authentication level to use when prompting the user for
- authentication. Defaults to strong.
- |
- Android | -
deviceCredentialFallback |
- Boolean (optional) |
- - Should the user be given the option to authenticate with their - device PIN, pattern, or password instead of a biometric. - | -Android | -
-- -- :warning: You need a real device to test Local Authentication for - iOS. Local Authentication is not available in simulators. -
-
- Credentials Manager errors -
-
- The Credentials Manager will only throw
- CredentialsManagerError exceptions. You can find more
- information in the details property of the exception.
-
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);
}
-
- Note : We have platform agnostic error codes available only
- for CredentialsManagerError as of now.
-
| Generic Error Code | -Corresponding Error Code in Android | -Corresponding Error Code in iOS | -
|---|---|---|
INVALID_CREDENTIALS |
- INVALID_CREDENTIALS |
- - |
NO_CREDENTIALS |
- NO_CREDENTIALS |
- noCredentials |
-
NO_REFRESH_TOKEN |
- NO_REFRESH_TOKEN |
- noRefreshToken |
-
RENEW_FAILED |
- RENEW_FAILED |
- renewFailed |
-
STORE_FAILED |
- STORE_FAILED |
- storeFailed |
-
REVOKE_FAILED |
- REVOKE_FAILED |
- revokeFailed |
-
LARGE_MIN_TTL |
- LARGE_MIN_TTL |
- largeMinTTL |
-
INCOMPATIBLE_DEVICE |
- INCOMPATIBLE_DEVICE |
- - |
CRYPTO_EXCEPTION |
- CRYPTO_EXCEPTION |
- - |
BIOMETRICS_FAILED |
-
- OneOf 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
- |
- biometricsFailed |
-
NO_NETWORK |
- NO_NETWORK |
- - |
API_ERROR |
- API_ERROR |
- - |
Feedback
- -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 development guide - -
Raise an issue
-- To provide feedback or report a bug, - please raise an issue on our issue tracker. -
- -- 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. -
--
-
-
- 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 - - LICENSE - file for more info. -
- - -
-
-
-
-
-
diff --git a/docs/interfaces/AuthorizeUrlOptions.md b/docs/interfaces/AuthorizeUrlOptions.md
new file mode 100644
index 00000000..2f3c2b90
--- /dev/null
+++ b/docs/interfaces/AuthorizeUrlOptions.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / AuthorizeUrlOptions
+
+# Interface: AuthorizeUrlOptions
+
+Defined in: [types.ts:205](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L205)
+
+Options for building a URL for `/authorize`
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+Custom parameters to send to `/authorize`
+
+## Properties
+
+### redirectUri
+
+> **redirectUri**: `object`
+
+Defined in: [types.ts:213](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L213)
+
+Where the authorization server will redirect back after success or failure.
+
+---
+
+### responseType
+
+> **responseType**: `string`
+
+Defined in: [types.ts:209](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L209)
+
+The response_type value
+
+---
+
+### state
+
+> **state**: `object`
+
+Defined in: [types.ts:217](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L217)
+
+Random string to prevent CSRF attacks.
diff --git a/docs/interfaces/ClearSessionOptions.html b/docs/interfaces/ClearSessionOptions.html
deleted file mode 100644
index 3f26a429..00000000
--- a/docs/interfaces/ClearSessionOptions.html
+++ /dev/null
@@ -1,406 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- redirect
-
-
-
-
- response
-
-
-
-
-
-
-
-
-
-
- Interface AuthorizeUrlOptions
-
-
-
- Options for building a URL for /authorize
- interface AuthorizeUrlOptions
- {
redirectUri: object;
responseType: string;
state: object;
[key: - string]: any;
} -
- redirectUri: object;
responseType: string;
state: object;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
- Custom parameters to send to /authorize
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- redirect
-
- redirect
-
-
-
-
- - Where the authorization server will redirect back after success - or failure. -
-
- response
-
- response
-
-
-
-
- The response_type value
-- state -
-
- state:
- object
-
-
-
-
-
- Random string to prevent CSRF attacks.
-
-
-
-
-
-
diff --git a/docs/interfaces/ClearSessionOptions.md b/docs/interfaces/ClearSessionOptions.md
new file mode 100644
index 00000000..fcd66a9a
--- /dev/null
+++ b/docs/interfaces/ClearSessionOptions.md
@@ -0,0 +1,31 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / ClearSessionOptions
+
+# Interface: ClearSessionOptions
+
+Defined in: [types.ts:180](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L180)
+
+Options for configuring the SDK's clear session behaviour.
+
+## Properties
+
+### customScheme?
+
+> `optional` **customScheme**: `string`
+
+Defined in: [types.ts:184](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L184)
+
+**Android only:** Custom scheme to build the callback URL with.
+
+---
+
+### useLegacyCallbackUrl?
+
+> `optional` **useLegacyCallbackUrl**: `boolean`
+
+Defined in: [types.ts:188](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L188)
+
+This will use older callback URL. See [https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration](https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration) for more details.
diff --git a/docs/interfaces/ClearSessionParameters.html b/docs/interfaces/ClearSessionParameters.html
deleted file mode 100644
index 4951790b..00000000
--- a/docs/interfaces/ClearSessionParameters.html
+++ /dev/null
@@ -1,424 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface ClearSessionOptions
-
-
-
- - Options for configuring the SDK's clear session behaviour. -
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- custom
-
- custom
-
-
-
-
- - Android only: Custom scheme to build the - callback URL with. -
-
- Optional
- use
-
- use
-
-
-
-
- - This will use older callback URL. See - https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration - for more details. -
-
-
-
-
-
-
diff --git a/docs/interfaces/ClearSessionParameters.md b/docs/interfaces/ClearSessionParameters.md
new file mode 100644
index 00000000..3a7aa216
--- /dev/null
+++ b/docs/interfaces/ClearSessionParameters.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / ClearSessionParameters
+
+# Interface: ClearSessionParameters
+
+Defined in: [types.ts:156](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L156)
+
+Parameters for sending to the Auth0 logout endpoint.
+
+## Properties
+
+### federated?
+
+> `optional` **federated**: `boolean`
+
+Defined in: [types.ts:162](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L162)
+
+If `true`, the user will be signed out of any connected identity providers in addition to their Auth0 session.
+
+#### Default
+
+`false`
+
+#### See
+
+https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps
+
+---
+
+### returnToUrl?
+
+> `optional` **returnToUrl**: `string`
+
+Defined in: [types.ts:174](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L174)
+
+Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.
+
+If you are using this, ensure a proper redirect URL is constructed in the following format
+Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+
+If you have `useLegacyCallbackUrl` set to true then the redirect URL should in the format
+Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
diff --git a/docs/interfaces/CreateUserOptions.html b/docs/interfaces/CreateUserOptions.html
deleted file mode 100644
index 68912e67..00000000
--- a/docs/interfaces/CreateUserOptions.html
+++ /dev/null
@@ -1,795 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface ClearSessionParameters
-
-
-
- Parameters for sending to the Auth0 logout endpoint.
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- federated?
- return
- Properties
-
- Optional
- federated
-
-
- federated?:
- boolean
-
-
-
-
- If true, the user will be signed out of any
- connected identity providers in addition to their Auth0 session.
-
-
-
- Default
-false
See
-- https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps -
-
- Optional
- return
-
- return
-
-
-
-
- - Specify a custom redirect URL to be used. Normally, you - wouldn't need to call this method manually as the default - value is autogenerated for you. -
-- If you are using this, ensure a proper redirect URL is - constructed in the following format Android: - {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -
-
- If you have useLegacyCallbackUrl set to true then
- the redirect URL should in the format Android:
- {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
- iOS:
- {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
-
-
-
-
-
-
diff --git a/docs/interfaces/CreateUserOptions.md b/docs/interfaces/CreateUserOptions.md
new file mode 100644
index 00000000..a2cafe9c
--- /dev/null
+++ b/docs/interfaces/CreateUserOptions.md
@@ -0,0 +1,115 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / CreateUserOptions
+
+# Interface: CreateUserOptions
+
+Defined in: [types.ts:537](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L537)
+
+Options for creating a new user.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### connection
+
+> **connection**: `string`
+
+Defined in: [types.ts:549](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L549)
+
+The name of the database connection where to create the user
+
+---
+
+### email
+
+> **email**: `string`
+
+Defined in: [types.ts:541](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L541)
+
+The user's email
+
+---
+
+### family_name?
+
+> `optional` **family_name**: `string`
+
+Defined in: [types.ts:561](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L561)
+
+The user's family name(s)
+
+---
+
+### given_name?
+
+> `optional` **given_name**: `string`
+
+Defined in: [types.ts:557](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L557)
+
+The user's given name(s)
+
+---
+
+### metadata?
+
+> `optional` **metadata**: `object`
+
+Defined in: [types.ts:577](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L577)
+
+Additional information that will be stored in `user_metadata`
+
+---
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types.ts:565](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L565)
+
+The user's full name
+
+---
+
+### nickname?
+
+> `optional` **nickname**: `string`
+
+Defined in: [types.ts:569](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L569)
+
+The user's nickname
+
+---
+
+### password
+
+> **password**: `string`
+
+Defined in: [types.ts:545](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L545)
+
+The user's password
+
+---
+
+### picture?
+
+> `optional` **picture**: `string`
+
+Defined in: [types.ts:573](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L573)
+
+A URL pointing to the user's picture
+
+---
+
+### username?
+
+> `optional` **username**: `string`
+
+Defined in: [types.ts:553](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L553)
+
+The user's username
diff --git a/docs/interfaces/ExchangeNativeSocialOptions.html b/docs/interfaces/ExchangeNativeSocialOptions.html
deleted file mode 100644
index e26a2f57..00000000
--- a/docs/interfaces/ExchangeNativeSocialOptions.html
+++ /dev/null
@@ -1,576 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface CreateUserOptions
-
-
-
- Options for creating a new user.
-
- interface CreateUserOptions
- {
connection: string;
email: string;
family_name?: string;
given_name?: string;
metadata?: object;
name?: string;
nickname?: string;
password: string;
picture?: string;
username?: string;
[key: - string]: any;
} -
- connection: string;
email: string;
family_name?: string;
given_name?: string;
metadata?: object;
name?: string;
nickname?: string;
password: string;
picture?: string;
username?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- connection
- email
- family_
- Properties
-- connection -
-
- connection:
- string
-
-
-
-
-
- - The name of the database connection where to create the user -
-- email -
-
- email:
- string
-
-
-
-
-
- The user's email
-
- Optional
- family_
-
- family_
-
-
-
-
- The user's family name(s)
-
- Optional
- given_
-
- given_
-
-
-
-
- The user's given name(s)
-
- Optional
- metadata
-
-
- metadata?:
- object
-
-
-
-
-
-
- Additional information that will be stored in
- user_metadata
-
- Optional
- name
-
-
- name?:
- string
-
-
-
-
-
- The user's full name
-
- Optional
- nickname
-
-
- nickname?:
- string
-
-
-
-
-
- The user's nickname
-- password -
-
- password:
- string
-
-
-
-
-
- The user's password
-
- Optional
- picture
-
-
- picture?:
- string
-
-
-
-
-
- A URL pointing to the user's picture
-
- Optional
- username
-
-
- username?:
- string
-
-
-
-
-
- The user's username
-
-
-
-
-
-
diff --git a/docs/interfaces/ExchangeNativeSocialOptions.md b/docs/interfaces/ExchangeNativeSocialOptions.md
new file mode 100644
index 00000000..d2d54d9b
--- /dev/null
+++ b/docs/interfaces/ExchangeNativeSocialOptions.md
@@ -0,0 +1,65 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / ExchangeNativeSocialOptions
+
+# Interface: ExchangeNativeSocialOptions
+
+Defined in: [types.ts:271](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L271)
+
+Options for obtaining user tokens from an external provider's token
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:287](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L287)
+
+The API audience to request
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:291](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L291)
+
+The scopes requested for the issued tokens. e.g. `openid profile`
+
+---
+
+### subjectToken
+
+> **subjectToken**: `string`
+
+Defined in: [types.ts:275](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L275)
+
+The token returned by the native social authentication solution
+
+---
+
+### subjectTokenType
+
+> **subjectTokenType**: `string`
+
+Defined in: [types.ts:279](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L279)
+
+The identifier that indicates the native social authentication solution
+
+---
+
+### userProfile?
+
+> `optional` **userProfile**: `string`
+
+Defined in: [types.ts:283](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L283)
+
+Additional profile attributes to set or override, only on select native social authentication solutions
diff --git a/docs/interfaces/ExchangeOptions.html b/docs/interfaces/ExchangeOptions.html
deleted file mode 100644
index af315318..00000000
--- a/docs/interfaces/ExchangeOptions.html
+++ /dev/null
@@ -1,456 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- subject
-
-
-
-
- subject
-
-
-
-
-
-
-
-
-
-
-
-
- Interface ExchangeNativeSocialOptions
-
-
-
- - Options for obtaining user tokens from an external provider's - token -
-
- interface ExchangeNativeSocialOptions
- {
audience?: string;
scope?: string;
subjectToken: string;
subjectTokenType: string;
userProfile?: string;
[key: - string]: any;
} -
- audience?: string;
scope?: string;
subjectToken: string;
subjectTokenType: string;
userProfile?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- The API audience to request
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
-
- The scopes requested for the issued tokens. e.g.
- openid profile
-
- subject
-
- subject
-
-
-
-
- - The token returned by the native social authentication solution -
-
- subject
-
- subject
-
-
-
-
- - The identifier that indicates the native social authentication - solution -
-
- Optional
- user
-
- user
-
-
-
-
- - Additional profile attributes to set or override, only on select - native social authentication solutions -
-
-
-
-
-
-
diff --git a/docs/interfaces/ExchangeOptions.md b/docs/interfaces/ExchangeOptions.md
new file mode 100644
index 00000000..e4e1818d
--- /dev/null
+++ b/docs/interfaces/ExchangeOptions.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / ExchangeOptions
+
+# Interface: ExchangeOptions
+
+Defined in: [types.ts:249](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L249)
+
+Options for the `/oauth/token` endpoint to exchange a code for an access token
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+Custom parameters to send to the /oauth/token endpoint
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+Defined in: [types.ts:253](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L253)
+
+The code returned by `/authorize`.
+
+---
+
+### redirectUri
+
+> **redirectUri**: `string`
+
+Defined in: [types.ts:261](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L261)
+
+The original redirectUri used when calling `/authorize`.
+
+---
+
+### verifier
+
+> **verifier**: `string`
+
+Defined in: [types.ts:257](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L257)
+
+The value used to generate the code challenge sent to `/authorize`.
diff --git a/docs/interfaces/GetUserOptions.html b/docs/interfaces/GetUserOptions.html
deleted file mode 100644
index 7e611167..00000000
--- a/docs/interfaces/GetUserOptions.html
+++ /dev/null
@@ -1,335 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- redirect
-
-
-
-
-
-
-
-
-
-
- Interface ExchangeOptions
-
-
-
-
- Options for the /oauth/token endpoint to exchange a
- code for an access token
-
- interface ExchangeOptions
- {
code: string;
redirectUri: string;
verifier: string;
[key: - string]: any;
} -
- code: string;
redirectUri: string;
verifier: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
- Custom parameters to send to the /oauth/token endpoint
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-- code -
-
- code:
- string
-
-
-
-
-
- The code returned by /authorize.
- redirect
-
- redirect
-
-
-
-
-
- The original redirectUri used when calling
- /authorize.
-
- verifier -
-
- verifier:
- string
-
-
-
-
-
-
- The value used to generate the code challenge sent to
- /authorize.
-
-
-
-
-
-
-
-
diff --git a/docs/interfaces/GetUserOptions.md b/docs/interfaces/GetUserOptions.md
new file mode 100644
index 00000000..0dbac817
--- /dev/null
+++ b/docs/interfaces/GetUserOptions.md
@@ -0,0 +1,21 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / GetUserOptions
+
+# Interface: GetUserOptions
+
+Defined in: [types.ts:191](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L191)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Defined in: [types.ts:192](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L192)
diff --git a/docs/interfaces/LocalAuthenticationOptions.html b/docs/interfaces/LocalAuthenticationOptions.html
deleted file mode 100644
index a82a96ae..00000000
--- a/docs/interfaces/LocalAuthenticationOptions.html
+++ /dev/null
@@ -1,750 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/interfaces/LocalAuthenticationOptions.md b/docs/interfaces/LocalAuthenticationOptions.md
new file mode 100644
index 00000000..41a3cc9c
--- /dev/null
+++ b/docs/interfaces/LocalAuthenticationOptions.md
@@ -0,0 +1,91 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LocalAuthenticationOptions
+
+# Interface: LocalAuthenticationOptions
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:8](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L8)
+
+The options for configuring the display of local authentication prompt, authentication level (Android only) and evaluation policy (iOS only).
+
+## Properties
+
+### authenticationLevel?
+
+> `optional` **authenticationLevel**: [`LocalAuthenticationLevel`](../enumerations/LocalAuthenticationLevel.md)
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:36](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L36)
+
+The authentication level to use when prompting the user for authentication. Defaults to LocalAuthenticationLevel.strong. **Applicable for Android only.**
+
+---
+
+### cancelTitle?
+
+> `optional` **cancelTitle**: `String`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:24](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L24)
+
+The cancel button title of the authentication prompt. **Applicable for both Android and iOS.**
+
+---
+
+### description?
+
+> `optional` **description**: `String`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:20](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L20)
+
+The description of the authentication prompt. **Applicable for Android only.**
+
+---
+
+### deviceCredentialFallback?
+
+> `optional` **deviceCredentialFallback**: `Boolean`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:40](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L40)
+
+Should the user be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. **Applicable for Android only.**
+
+---
+
+### evaluationPolicy?
+
+> `optional` **evaluationPolicy**: [`LocalAuthenticationStrategy`](../enumerations/LocalAuthenticationStrategy.md)
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:28](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L28)
+
+The evaluation policy to use when prompting the user for authentication. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics. **Applicable for iOS only.**
+
+---
+
+### fallbackTitle?
+
+> `optional` **fallbackTitle**: `String`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:32](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L32)
+
+The fallback button title of the authentication prompt. **Applicable for iOS only.**
+
+---
+
+### subtitle?
+
+> `optional` **subtitle**: `String`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:16](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L16)
+
+The subtitle of the authentication prompt. **Applicable for Android only.**
+
+---
+
+### title
+
+> **title**: `String`
+
+Defined in: [credentials-manager/localAuthenticationOptions.ts:12](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/credentials-manager/localAuthenticationOptions.ts#L12)
+
+The title of the authentication prompt. **Applicable for both Android and iOS**.
diff --git a/docs/interfaces/LoginWithEmailOptions.html b/docs/interfaces/LoginWithEmailOptions.html
deleted file mode 100644
index 4ef689f0..00000000
--- a/docs/interfaces/LoginWithEmailOptions.html
+++ /dev/null
@@ -1,498 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface LocalAuthenticationOptions
-
-
-
- - The options for configuring the display of local authentication - prompt, authentication level (Android only) and evaluation policy - (iOS only). -
-
- interface LocalAuthenticationOptions
- {
authenticationLevel?: LocalAuthenticationLevel;
cancelTitle?: String;
description?: String;
deviceCredentialFallback?: Boolean;
evaluationPolicy?: LocalAuthenticationStrategy;
fallbackTitle?: String;
subtitle?: String;
title: String;
} -
-
- authenticationLevel?: LocalAuthenticationLevel;
cancelTitle?: String;
description?: String;
deviceCredentialFallback?: Boolean;
evaluationPolicy?: LocalAuthenticationStrategy;
fallbackTitle?: String;
subtitle?: String;
title: String;
} -
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- authentication
-
-
-
-
-
- - The authentication level to use when prompting the user for - authentication. Defaults to LocalAuthenticationLevel.strong. - Applicable for Android only. -
-
- Optional
- cancel
-
- cancel
-
-
-
-
- - The cancel button title of the authentication prompt. - Applicable for both Android and iOS. -
-
- Optional
- description
-
-
- description?:
- String
-
-
-
-
-
- - The description of the authentication prompt. - Applicable for Android only. -
-
- Optional
- device
-
- device
-
-
-
-
- - Should the user be given the option to authenticate with their - device PIN, pattern, or password instead of a biometric. - Applicable for Android only. -
-
- Optional
- evaluation
-
-
-
-
-
- - The evaluation policy to use when prompting the user for - authentication. Defaults to - LocalAuthenticationStrategy.deviceOwnerWithBiometrics. - Applicable for iOS only. -
-
- Optional
- fallback
-
- fallback
-
-
-
-
- - The fallback button title of the authentication prompt. - Applicable for iOS only. -
-
- Optional
- subtitle
-
-
- subtitle?:
- String
-
-
-
-
-
- - The subtitle of the authentication prompt. - Applicable for Android only. -
-- title -
-
- title:
- String
-
-
-
-
-
- - The title of the authentication prompt. - Applicable for both Android and iOS. -
-
-
-
-
-
-
diff --git a/docs/interfaces/LoginWithEmailOptions.md b/docs/interfaces/LoginWithEmailOptions.md
new file mode 100644
index 00000000..e80929bd
--- /dev/null
+++ b/docs/interfaces/LoginWithEmailOptions.md
@@ -0,0 +1,55 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LoginWithEmailOptions
+
+# Interface: LoginWithEmailOptions
+
+Defined in: [types.ts:378](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L378)
+
+The options for completing the passwordless login with email request
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:390](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L390)
+
+The API audience to request
+
+---
+
+### code
+
+> **code**: `string`
+
+Defined in: [types.ts:386](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L386)
+
+The code numeric value (OTP)
+
+---
+
+### email
+
+> **email**: `string`
+
+Defined in: [types.ts:382](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L382)
+
+The email where the link/code was received
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:394](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L394)
+
+The scopes to request
diff --git a/docs/interfaces/LoginWithOOBOptions.html b/docs/interfaces/LoginWithOOBOptions.html
deleted file mode 100644
index f6b0452c..00000000
--- a/docs/interfaces/LoginWithOOBOptions.html
+++ /dev/null
@@ -1,454 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface LoginWithEmailOptions
-
-
-
- - The options for completing the passwordless login with email - request -
-
- interface LoginWithEmailOptions
- {
audience?: string;
code: string;
email: string;
scope?: string;
[key: - string]: any;
} -
- audience?: string;
code: string;
email: string;
scope?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
- Properties
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- The API audience to request
-- code -
-
- code:
- string
-
-
-
-
-
- The code numeric value (OTP)
-- email -
-
- email:
- string
-
-
-
-
-
- The email where the link/code was received
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
- The scopes to request
-
-
-
-
-
-
diff --git a/docs/interfaces/LoginWithOOBOptions.md b/docs/interfaces/LoginWithOOBOptions.md
new file mode 100644
index 00000000..fb8ec2d0
--- /dev/null
+++ b/docs/interfaces/LoginWithOOBOptions.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LoginWithOOBOptions
+
+# Interface: LoginWithOOBOptions
+
+Defined in: [types.ts:444](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L444)
+
+Options for logging in using an OOB code
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### bindingCode?
+
+> `optional` **bindingCode**: `string`
+
+Defined in: [types.ts:458](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L458)
+
+The code used to bind the side channel (used to deliver the challenge) with the
+main channel you are using to authenticate. This is usually an OTP-like code
+delivered as part of the challenge message.
+
+---
+
+### mfaToken
+
+> **mfaToken**: `string`
+
+Defined in: [types.ts:448](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L448)
+
+The token received in the previous login response
+
+---
+
+### oobCode
+
+> **oobCode**: `string`
+
+Defined in: [types.ts:452](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L452)
+
+The out of band code received in the challenge response.
diff --git a/docs/interfaces/LoginWithOTPOptions.html b/docs/interfaces/LoginWithOTPOptions.html
deleted file mode 100644
index dc80fdf5..00000000
--- a/docs/interfaces/LoginWithOTPOptions.html
+++ /dev/null
@@ -1,451 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- mfa
-
-
-
-
- oob
-
-
-
-
-
-
-
- Interface LoginWithOOBOptions
-
-
-
- Options for logging in using an OOB code
-
- interface LoginWithOOBOptions
- {
bindingCode?: string;
mfaToken: string;
oobCode: string;
[key: - string]: any;
} -
- bindingCode?: string;
mfaToken: string;
oobCode: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- binding
-
- binding
-
-
-
-
- - The code used to bind the side channel (used to deliver the - challenge) with the main channel you are using to authenticate. - This is usually an OTP-like code delivered as part of the - challenge message. -
-
- mfa
-
- mfa
-
-
-
-
- The token received in the previous login response
-
- oob
-
- oob
-
-
-
-
- The out of band code received in the challenge response.
-
-
-
-
-
-
diff --git a/docs/interfaces/LoginWithOTPOptions.md b/docs/interfaces/LoginWithOTPOptions.md
new file mode 100644
index 00000000..9a1eb8dc
--- /dev/null
+++ b/docs/interfaces/LoginWithOTPOptions.md
@@ -0,0 +1,46 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LoginWithOTPOptions
+
+# Interface: LoginWithOTPOptions
+
+Defined in: [types.ts:424](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L424)
+
+Options for logging in using an OTP code
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:437](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L437)
+
+The API audience
+
+---
+
+### mfaToken
+
+> **mfaToken**: `string`
+
+Defined in: [types.ts:428](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L428)
+
+The token received in the previous login response
+
+---
+
+### otp
+
+> **otp**: `string`
+
+Defined in: [types.ts:433](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L433)
+
+The one time password code provided by the resource owner, typically obtained
+from an MFA application such as Google Authenticator or Guardian.
diff --git a/docs/interfaces/LoginWithRecoveryCodeOptions.html b/docs/interfaces/LoginWithRecoveryCodeOptions.html
deleted file mode 100644
index 75f7caa6..00000000
--- a/docs/interfaces/LoginWithRecoveryCodeOptions.html
+++ /dev/null
@@ -1,408 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- mfa
-
-
-
-
-
-
-
-
-
-
- Interface LoginWithOTPOptions
-
-
-
- Options for logging in using an OTP code
-
- interface LoginWithOTPOptions
- {
audience?: string;
mfaToken: string;
otp: string;
[key: - string]: any;
} -
- audience?: string;
mfaToken: string;
otp: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
- Properties
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- The API audience
-
- mfa
-
- mfa
-
-
-
-
- The token received in the previous login response
-- otp -
-
- otp:
- string
-
-
-
-
-
- - The one time password code provided by the resource owner, - typically obtained from an MFA application such as Google - Authenticator or Guardian. -
-
-
-
-
-
-
diff --git a/docs/interfaces/LoginWithRecoveryCodeOptions.md b/docs/interfaces/LoginWithRecoveryCodeOptions.md
new file mode 100644
index 00000000..2cddb9a3
--- /dev/null
+++ b/docs/interfaces/LoginWithRecoveryCodeOptions.md
@@ -0,0 +1,35 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LoginWithRecoveryCodeOptions
+
+# Interface: LoginWithRecoveryCodeOptions
+
+Defined in: [types.ts:465](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L465)
+
+Options for logging in using a recovery code
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### mfaToken
+
+> **mfaToken**: `string`
+
+Defined in: [types.ts:469](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L469)
+
+The token received in the previous login response
+
+---
+
+### recoveryCode
+
+> **recoveryCode**: `string`
+
+Defined in: [types.ts:473](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L473)
+
+The recovery code provided by the end-user.
diff --git a/docs/interfaces/LoginWithSMSOptions.html b/docs/interfaces/LoginWithSMSOptions.html
deleted file mode 100644
index 5c37683d..00000000
--- a/docs/interfaces/LoginWithSMSOptions.html
+++ /dev/null
@@ -1,498 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- mfa
-
-
-
-
- recovery
-
-
-
-
-
-
-
- Interface LoginWithRecoveryCodeOptions
-
-
-
- Options for logging in using a recovery code
-
- interface LoginWithRecoveryCodeOptions
- {
mfaToken: string;
recoveryCode: string;
[key: - string]: any;
} -
- mfaToken: string;
recoveryCode: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- mfa
- Properties
-
- mfa
-
- mfa
-
-
-
-
- The token received in the previous login response
-
- recovery
-
- recovery
-
-
-
-
- The recovery code provided by the end-user.
-
-
-
-
-
-
diff --git a/docs/interfaces/LoginWithSMSOptions.md b/docs/interfaces/LoginWithSMSOptions.md
new file mode 100644
index 00000000..c0e34974
--- /dev/null
+++ b/docs/interfaces/LoginWithSMSOptions.md
@@ -0,0 +1,55 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LoginWithSMSOptions
+
+# Interface: LoginWithSMSOptions
+
+Defined in: [types.ts:401](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L401)
+
+The options for completing the passwordless login with SMS request
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:413](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L413)
+
+Optional API audience to request
+
+---
+
+### code
+
+> **code**: `string`
+
+Defined in: [types.ts:409](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L409)
+
+The code numeric value (OTP)
+
+---
+
+### phoneNumber
+
+> **phoneNumber**: `string`
+
+Defined in: [types.ts:405](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L405)
+
+The phone number where the code was received
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:417](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L417)
+
+Optional scopes to request
diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html
deleted file mode 100644
index 44b51a2a..00000000
--- a/docs/interfaces/LogoutUrlOptions.html
+++ /dev/null
@@ -1,462 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- phone
-
-
-
-
-
-
-
-
-
-
-
-
- Interface LoginWithSMSOptions
-
-
-
- - The options for completing the passwordless login with SMS request -
-
- interface LoginWithSMSOptions
- {
audience?: string;
code: string;
phoneNumber: string;
scope?: string;
[key: - string]: any;
} -
- audience?: string;
code: string;
phoneNumber: string;
scope?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- Optional API audience to request
-- code -
-
- code:
- string
-
-
-
-
-
- The code numeric value (OTP)
-
- phone
-
- phone
-
-
-
-
- The phone number where the code was received
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
- Optional scopes to request
-
-
-
-
-
-
diff --git a/docs/interfaces/LogoutUrlOptions.md b/docs/interfaces/LogoutUrlOptions.md
new file mode 100644
index 00000000..21ece5dd
--- /dev/null
+++ b/docs/interfaces/LogoutUrlOptions.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / LogoutUrlOptions
+
+# Interface: LogoutUrlOptions
+
+Defined in: [types.ts:227](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L227)
+
+Options for the logout endpoint
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+Custom parameters to send to the logout endpoint
+
+## Properties
+
+### clientId?
+
+> `optional` **clientId**: `string`
+
+Defined in: [types.ts:235](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L235)
+
+The client identifier of the one requesting the logout
+
+---
+
+### federated?
+
+> `optional` **federated**: `boolean`
+
+Defined in: [types.ts:231](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L231)
+
+Whether the logout should include removing session for federated IdP.
+
+---
+
+### returnTo?
+
+> `optional` **returnTo**: `string`
+
+Defined in: [types.ts:239](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L239)
+
+URL where the user is redirected to after logout. It must be declared in you Auth0 Dashboard
diff --git a/docs/interfaces/MultifactorChallengeOptions.html b/docs/interfaces/MultifactorChallengeOptions.html
deleted file mode 100644
index f599aac5..00000000
--- a/docs/interfaces/MultifactorChallengeOptions.html
+++ /dev/null
@@ -1,466 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface LogoutUrlOptions
-
-
-
- Options for the logout endpoint
-
- interface LogoutUrlOptions
- {
clientId?: string;
federated?: boolean;
returnTo?: string;
[key: - string]: any;
} -
- clientId?: string;
federated?: boolean;
returnTo?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
- Custom parameters to send to the logout endpoint
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- client
-
- client
-
-
-
-
- The client identifier of the one requesting the logout
-
- Optional
- federated
-
-
- federated?:
- boolean
-
-
-
-
-
- - Whether the logout should include removing session for federated - IdP. -
-
- Optional
- return
-
- return
-
-
-
-
- - URL where the user is redirected to after logout. It must be - declared in you Auth0 Dashboard -
-
-
-
-
-
-
diff --git a/docs/interfaces/MultifactorChallengeOptions.md b/docs/interfaces/MultifactorChallengeOptions.md
new file mode 100644
index 00000000..4094f20f
--- /dev/null
+++ b/docs/interfaces/MultifactorChallengeOptions.md
@@ -0,0 +1,47 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / MultifactorChallengeOptions
+
+# Interface: MultifactorChallengeOptions
+
+Defined in: [types.ts:480](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L480)
+
+Options for multifactor challenge.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### authenticatorId?
+
+> `optional` **authenticatorId**: `string`
+
+Defined in: [types.ts:494](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L494)
+
+The ID of the authenticator to challenge.
+
+---
+
+### challengeType?
+
+> `optional` **challengeType**: `string`
+
+Defined in: [types.ts:490](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L490)
+
+A whitespace-separated list of the challenges types accepted by your application.
+Accepted challenge types are oob or otp. Excluding this parameter means that your client application
+accepts all supported challenge types.
+
+---
+
+### mfaToken
+
+> **mfaToken**: `string`
+
+Defined in: [types.ts:484](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L484)
+
+The token received in the previous login response
diff --git a/docs/interfaces/PasswordRealmOptions.html b/docs/interfaces/PasswordRealmOptions.html
deleted file mode 100644
index b7911721..00000000
--- a/docs/interfaces/PasswordRealmOptions.html
+++ /dev/null
@@ -1,560 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- mfa
-
-
-
-
-
-
-
- Interface MultifactorChallengeOptions
-
-
-
- Options for multifactor challenge.
-
- interface MultifactorChallengeOptions
- {
authenticatorId?: string;
challengeType?: string;
mfaToken: string;
[key: - string]: any;
} -
- authenticatorId?: string;
challengeType?: string;
mfaToken: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- authenticator
-
- authenticator
-
-
-
-
- The ID of the authenticator to challenge.
-
- Optional
- challenge
-
- challenge
-
-
-
-
- - A whitespace-separated list of the challenges types accepted by - your application. Accepted challenge types are oob or otp. - Excluding this parameter means that your client application - accepts all supported challenge types. -
-
- mfa
-
- mfa
-
-
-
-
- The token received in the previous login response
-
-
-
-
-
-
diff --git a/docs/interfaces/PasswordRealmOptions.md b/docs/interfaces/PasswordRealmOptions.md
new file mode 100644
index 00000000..6ea26546
--- /dev/null
+++ b/docs/interfaces/PasswordRealmOptions.md
@@ -0,0 +1,65 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / PasswordRealmOptions
+
+# Interface: PasswordRealmOptions
+
+Defined in: [types.ts:298](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L298)
+
+Options for authenticating using the username & password grant.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:314](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L314)
+
+The identifier of Resource Server (RS) to be included as audience (aud claim) of the issued access token
+
+---
+
+### password
+
+> **password**: `string`
+
+Defined in: [types.ts:306](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L306)
+
+The user's password
+
+---
+
+### realm
+
+> **realm**: `string`
+
+Defined in: [types.ts:310](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L310)
+
+The name of the Realm where to Auth (or connection name)
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:318](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L318)
+
+The scopes requested for the issued tokens. e.g. `openid profile`
+
+---
+
+### username
+
+> **username**: `string`
+
+Defined in: [types.ts:302](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L302)
+
+The user's username or email
diff --git a/docs/interfaces/PasswordlessWithEmailOptions.html b/docs/interfaces/PasswordlessWithEmailOptions.html
deleted file mode 100644
index b7093494..00000000
--- a/docs/interfaces/PasswordlessWithEmailOptions.html
+++ /dev/null
@@ -1,458 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface PasswordRealmOptions
-
-
-
- - Options for authenticating using the username & password - grant. -
-
- interface PasswordRealmOptions
- {
audience?: string;
password: string;
realm: string;
scope?: string;
username: string;
[key: - string]: any;
} -
- audience?: string;
password: string;
realm: string;
scope?: string;
username: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
- Properties
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- - The identifier of Resource Server (RS) to be included as - audience (aud claim) of the issued access token -
-- password -
-
- password:
- string
-
-
-
-
-
- The user's password
-- realm -
-
- realm:
- string
-
-
-
-
-
- The name of the Realm where to Auth (or connection name)
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
-
- The scopes requested for the issued tokens. e.g.
- openid profile
-
- username -
-
- username:
- string
-
-
-
-
-
- The user's username or email
-
-
-
-
-
-
diff --git a/docs/interfaces/PasswordlessWithEmailOptions.md b/docs/interfaces/PasswordlessWithEmailOptions.md
new file mode 100644
index 00000000..43d51513
--- /dev/null
+++ b/docs/interfaces/PasswordlessWithEmailOptions.md
@@ -0,0 +1,45 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / PasswordlessWithEmailOptions
+
+# Interface: PasswordlessWithEmailOptions
+
+Defined in: [types.ts:340](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L340)
+
+Options for requesting passwordless login using email
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### authParams?
+
+> `optional` **authParams**: `object`
+
+Defined in: [types.ts:352](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L352)
+
+Optional parameters, used when strategy is 'linḱ'
+
+---
+
+### email
+
+> **email**: `string`
+
+Defined in: [types.ts:344](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L344)
+
+The email to send the link/code to
+
+---
+
+### send?
+
+> `optional` **send**: `string`
+
+Defined in: [types.ts:348](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L348)
+
+The passwordless strategy, either 'link' or 'code'
diff --git a/docs/interfaces/PasswordlessWithSMSOptions.html b/docs/interfaces/PasswordlessWithSMSOptions.html
deleted file mode 100644
index c90abe47..00000000
--- a/docs/interfaces/PasswordlessWithSMSOptions.html
+++ /dev/null
@@ -1,461 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface PasswordlessWithEmailOptions
-
-
-
- Options for requesting passwordless login using email
-
- interface PasswordlessWithEmailOptions
- {
authParams?: object;
email: string;
send?: string;
[key: - string]: any;
} -
- authParams?: object;
email: string;
send?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- auth
-
- auth
-
-
-
-
- Optional parameters, used when strategy is 'linḱ'
-- email -
-
- email:
- string
-
-
-
-
-
- The email to send the link/code to
-
- Optional
- send
-
-
- send?:
- string
-
-
-
-
-
- - The passwordless strategy, either 'link' or - 'code' -
-
-
-
-
-
-
diff --git a/docs/interfaces/PasswordlessWithSMSOptions.md b/docs/interfaces/PasswordlessWithSMSOptions.md
new file mode 100644
index 00000000..f5d9e7d1
--- /dev/null
+++ b/docs/interfaces/PasswordlessWithSMSOptions.md
@@ -0,0 +1,45 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / PasswordlessWithSMSOptions
+
+# Interface: PasswordlessWithSMSOptions
+
+Defined in: [types.ts:359](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L359)
+
+Options for requesting passwordless login using SMS
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### authParams?
+
+> `optional` **authParams**: `object`
+
+Defined in: [types.ts:371](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L371)
+
+Optional passwordless parameters
+
+---
+
+### phoneNumber
+
+> **phoneNumber**: `string`
+
+Defined in: [types.ts:363](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L363)
+
+The phone number to send the link/code to
+
+---
+
+### send?
+
+> `optional` **send**: `string`
+
+Defined in: [types.ts:367](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L367)
+
+The passwordless strategy, either 'link' or 'code'
diff --git a/docs/interfaces/PatchUserOptions.html b/docs/interfaces/PatchUserOptions.html
deleted file mode 100644
index 38f4da1d..00000000
--- a/docs/interfaces/PatchUserOptions.html
+++ /dev/null
@@ -1,380 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- phone
-
-
-
-
-
-
-
-
-
-
-
-
- Interface PasswordlessWithSMSOptions
-
-
-
- Options for requesting passwordless login using SMS
-
- interface PasswordlessWithSMSOptions
- {
authParams?: object;
phoneNumber: string;
send?: string;
[key: - string]: any;
} -
- authParams?: object;
phoneNumber: string;
send?: string;
[key: - string]: any;
} -
Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- auth
-
- auth
-
-
-
-
- Optional passwordless parameters
-
- phone
-
- phone
-
-
-
-
- The phone number to send the link/code to
-
- Optional
- send
-
-
- send?:
- string
-
-
-
-
-
- - The passwordless strategy, either 'link' or - 'code' -
-
-
-
-
-
-
-
-
diff --git a/docs/interfaces/PatchUserOptions.md b/docs/interfaces/PatchUserOptions.md
new file mode 100644
index 00000000..40f882b1
--- /dev/null
+++ b/docs/interfaces/PatchUserOptions.md
@@ -0,0 +1,29 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / PatchUserOptions
+
+# Interface: PatchUserOptions
+
+Defined in: [types.ts:196](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L196)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Defined in: [types.ts:197](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L197)
+
+---
+
+### metadata
+
+> **metadata**: `object`
+
+Defined in: [types.ts:198](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L198)
diff --git a/docs/interfaces/RefreshTokenOptions.html b/docs/interfaces/RefreshTokenOptions.html
deleted file mode 100644
index 83f093b6..00000000
--- a/docs/interfaces/RefreshTokenOptions.html
+++ /dev/null
@@ -1,403 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/interfaces/RefreshTokenOptions.md b/docs/interfaces/RefreshTokenOptions.md
new file mode 100644
index 00000000..ae75cb20
--- /dev/null
+++ b/docs/interfaces/RefreshTokenOptions.md
@@ -0,0 +1,35 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / RefreshTokenOptions
+
+# Interface: RefreshTokenOptions
+
+Defined in: [types.ts:325](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L325)
+
+Refresh token parameters
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### refreshToken
+
+> **refreshToken**: `string`
+
+Defined in: [types.ts:329](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L329)
+
+The issued refresh token
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:333](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L333)
+
+The scopes requested for the issued tokens. e.g. `openid profile`
diff --git a/docs/interfaces/ResetPasswordOptions.html b/docs/interfaces/ResetPasswordOptions.html
deleted file mode 100644
index 182484dc..00000000
--- a/docs/interfaces/ResetPasswordOptions.html
+++ /dev/null
@@ -1,401 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- refresh
-
-
-
-
-
-
-
-
-
-
-
-
- Interface RefreshTokenOptions
-
-
-
- Refresh token parameters
-Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- refresh
- Properties
-
- refresh
-
- refresh
-
-
-
-
- The issued refresh token
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
-
- The scopes requested for the issued tokens. e.g.
- openid profile
-
-
-
-
-
-
diff --git a/docs/interfaces/ResetPasswordOptions.md b/docs/interfaces/ResetPasswordOptions.md
new file mode 100644
index 00000000..f27f2256
--- /dev/null
+++ b/docs/interfaces/ResetPasswordOptions.md
@@ -0,0 +1,35 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / ResetPasswordOptions
+
+# Interface: ResetPasswordOptions
+
+Defined in: [types.ts:522](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L522)
+
+Options for resetting a user's password.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### connection
+
+> **connection**: `string`
+
+Defined in: [types.ts:530](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L530)
+
+The name of the database connection of the user
+
+---
+
+### email
+
+> **email**: `string`
+
+Defined in: [types.ts:526](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L526)
+
+The user's email
diff --git a/docs/interfaces/RevokeOptions.html b/docs/interfaces/RevokeOptions.html
deleted file mode 100644
index 4ce97464..00000000
--- a/docs/interfaces/RevokeOptions.html
+++ /dev/null
@@ -1,351 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface ResetPasswordOptions
-
-
-
- Options for resetting a user's password.
-Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- connection
- email
-
- Properties
-- connection -
-
- connection:
- string
-
-
-
-
-
- The name of the database connection of the user
-- email -
-
- email:
- string
-
-
-
-
-
- The user's email
-
-
-
-
-
-
diff --git a/docs/interfaces/RevokeOptions.md b/docs/interfaces/RevokeOptions.md
new file mode 100644
index 00000000..ed6ce07d
--- /dev/null
+++ b/docs/interfaces/RevokeOptions.md
@@ -0,0 +1,25 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / RevokeOptions
+
+# Interface: RevokeOptions
+
+Defined in: [types.ts:501](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L501)
+
+Options for the revoke refresh token endpoint.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### refreshToken
+
+> **refreshToken**: `string`
+
+Defined in: [types.ts:505](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L505)
+
+The user's issued refresh token
diff --git a/docs/interfaces/Types.Auth0ContextInterface.html b/docs/interfaces/Types.Auth0ContextInterface.html
deleted file mode 100644
index 0e1cf4e9..00000000
--- a/docs/interfaces/Types.Auth0ContextInterface.html
+++ /dev/null
@@ -1,3059 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- refresh
-
-
-
-
-
-
-
- Interface RevokeOptions
-
-
-
- Options for the revoke refresh token endpoint.
-Indexable
-
- [key:
- string]: any
-
-
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- refresh
- Properties
-
- refresh
-
- refresh
-
-
-
-
- The user's issued refresh token
-
-
-
-
-
-
diff --git a/docs/interfaces/Types.AuthState.html b/docs/interfaces/Types.AuthState.html
deleted file mode 100644
index e3e038ac..00000000
--- a/docs/interfaces/Types.AuthState.html
+++ /dev/null
@@ -1,496 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- authorize
-
-
-
-
-
- cancel
-
-
-
-
- clear
-
-
-
-
- clear
-
-
-
-
-
-
-
- get
-
-
-
-
-
-
- has
-
-
-
-
- is
-
-
-
-
- reset
-
-
-
-
- revoke
-
-
-
-
- send
-
-
-
-
- send
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface Auth0ContextInterface<TUser>
-
- interface Auth0ContextInterface<TUser>
- {
authorize: ((parameters?, - options?) => Promise<undefined | Credentials>);
authorizeWithEmail: ((parameters) => Promise<undefined | Credentials>);
authorizeWithExchangeNativeSocial: ((parameters) => Promise<undefined | Credentials>);
authorizeWithOOB: ((parameters) => Promise<undefined | Credentials>);
authorizeWithOTP: ((parameters) => Promise<undefined | Credentials>);
authorizeWithPasswordRealm: ((parameters) => Promise<undefined | Credentials>);
authorizeWithRecoveryCode: ((parameters) => Promise<undefined | Credentials>);
authorizeWithSMS: ((parameters) => Promise<undefined | Credentials>);
cancelWebAuth: (() => Promise<void>);
clearCredentials: (() => Promise<void>);
clearSession: ((parameters?, - options?) => Promise<void>);
error: null | BaseError;
getCredentials: ((scope?, - minTtl?, - parameters?, - forceRefresh?) => Promise<undefined | Credentials>);
hasValidCredentials: ((minTtl?) => Promise<boolean>);
isLoading: boolean;
resetPassword: ((parameters) => Promise<void>);
revokeRefreshToken: ((parameters) => Promise<void>);
sendEmailCode: ((parameters) => Promise<void>);
sendMultifactorChallenge: ((parameters) => Promise<void>);
sendSMSCode: ((parameters) => Promise<void>);
user: null | TUser;
} -
- authorize: ((parameters?, - options?) => Promise<undefined | Credentials>);
authorizeWithEmail: ((parameters) => Promise<undefined | Credentials>);
authorizeWithExchangeNativeSocial: ((parameters) => Promise<undefined | Credentials>);
authorizeWithOOB: ((parameters) => Promise<undefined | Credentials>);
authorizeWithOTP: ((parameters) => Promise<undefined | Credentials>);
authorizeWithPasswordRealm: ((parameters) => Promise<undefined | Credentials>);
authorizeWithRecoveryCode: ((parameters) => Promise<undefined | Credentials>);
authorizeWithSMS: ((parameters) => Promise<undefined | Credentials>);
cancelWebAuth: (() => Promise<void>);
clearCredentials: (() => Promise<void>);
clearSession: ((parameters?, - options?) => Promise<void>);
error: null | BaseError;
getCredentials: ((scope?, - minTtl?, - parameters?, - forceRefresh?) => Promise<undefined | Credentials>);
hasValidCredentials: ((minTtl?) => Promise<boolean>);
isLoading: boolean;
resetPassword: ((parameters) => Promise<void>);
revokeRefreshToken: ((parameters) => Promise<void>);
sendEmailCode: ((parameters) => Promise<void>);
sendMultifactorChallenge: ((parameters) => Promise<void>);
sendSMSCode: ((parameters) => Promise<void>);
user: null | TUser;
} -
Type Parameters
- -- Hierarchy (view full) -
- -
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- authorize
- authorize
- Properties
-- authorize -
- -
-
- - Authorize the user using Auth0 Universal Login. See - WebAuth#authorize -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters?, - options?): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
-
-
Optional- parameters: - WebAuthorizeParameters --- -- The parameters that are sent to the -
-/authorizeendpoint. -
- -
-
Optional- options: - WebAuthorizeOptions --- -- Options for customizing the SDK's handling - of the authorize call -
-
-
- Returns Promise<undefined | Credentials> -
-
- -
-
-
- authorize
-
-
-
- - Authorize the user using an email code. See - Auth#loginWithEmail -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - LoginWithEmailOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Authorize user with credentials using the Password Realm Grant. - See - Auth#passwordRealm -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - ExchangeNativeSocialOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Authorize the user using an Out Of Band authentication code. See - Auth#loginWithOOB -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - LoginWithOOBOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Autohrize the user using a One Time Password code. See - Auth#loginWithOTP. -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - LoginWithOTPOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Authorize user with credentials using the Password Realm Grant. - See - Auth#passwordRealm -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - PasswordRealmOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Authorize the user using a multi-factor authentication Recovery - Code. See - Auth#loginWithRecoveryCode -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - LoginWithRecoveryCodeOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- authorize
-
-
-
- - Authorize the user using a SMS code. See - Auth#loginWithSMS -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
- - parameters: - LoginWithSMSOptions - -
- Returns Promise<undefined | Credentials> -
-
-
-
- cancel
-
- cancel
-
-
- - Cancel any ongoing Universal Login transaction. This works only - on iOS and not on any other platforms -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (): Promise<void> - -
-
-
- Returns Promise<void> -
-
-
-
- clear
-
- clear
-
-
- - Clears the user's credentials without clearing their web - session and logs them out. -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (): Promise<void> - -
-
-
- Returns Promise<void> -
-
-
-
- clear
-
- clear
-
-
- - Clears the user's web session, credentials and logs them - out. See - WebAuth#clearSession -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters?, - options?): Promise<void> - -
-
- --
Parameters
--
-
-
-
Optional- parameters: - ClearSessionParameters --- -- Additional parameters to send to the Auth0 - logout endpoint. -
-
- -
-
Optional- options: - ClearSessionOptions --- -- Options for configuring the SDK's clear - session behaviour. -
-
-
- Returns Promise<void> -
-
- -
-
-
- error -
- -
-
-
-
- An object representing the last exception
-
- get
-
- get
-
-
- - Gets the user's credentials from the native credential - store. If credentials have expired, they are automatically - refreshed by default. See - CredentialsManager#getCredentials -
-
-
- Type declaration
--
-
-
-
-
-
- - (scope?, - minTtl?, - parameters?, - forceRefresh?): Promise<undefined | Credentials> - -
-
- --
Parameters
--
-
-
-
Optional- scope: - string --- -The scopes used to get the credentials
-
- -
-
Optional- minTtl: - number --- -- The minimum time in seconds that the access - token should last before expiration -
-
- -
-
Optional- parameters: Record<string, unknown> --- -- Any additional parameters to send in the request - to refresh expired credentials. -
-
- -
-
Optional- forceRefresh: - boolean --- -- If
-true, credentials are always - refreshed regardless of their expiry, provided a - valid refresh token is available. -
-
- Returns Promise<undefined | Credentials> -
-
- -
-
-
Returns
- has
-
- has
-
-
- - Whether the SDK currently holds valid, unexpired credentials. -
-
-
- Type declaration
--
-
-
-
-
-
- - (minTtl?): Promise<boolean> - -
-
- --
Parameters
--
-
-
-
Optional- minTtl: - number --- -- The minimum time in seconds that the access - token should last before expiration -
-
-
- Returns Promise<boolean> -
-
- -
-
-
-
-
- Returns
-
- true if there are valid credentials. Otherwise,
- false.
-
- is
-
- is
-
-
-
-
- - A flag that is true until the state knows that a user is either - logged in or not -
-
- reset
-
- reset
-
-
- - Request an email with instructions to change password of a user - Auth#resetPassword -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<void> - -
-
- --
Parameters
--
-
- - parameters: - ResetPasswordOptions - -
- Returns Promise<void> -
-
-
-
- revoke
-
- revoke
-
-
- - Revokes an issued refresh token. See - Auth#revoke -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<void> - -
-
- --
Parameters
--
-
- - parameters: - RevokeOptions - -
- Returns Promise<void> -
-
-
-
- send
-
- send
-
-
- - Start the passwordless email login flow. See - Auth#passwordlessWithEmail -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<void> - -
-
- --
Parameters
--
-
- - parameters: - PasswordlessWithEmailOptions - -
- Returns Promise<void> -
-
-
-
- send
-
- send
-
-
- - Send a challenge for multi-factor authentication. See - Auth#multifactorChallenge -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<void> - -
-
- --
Parameters
--
-
- - parameters: - MultifactorChallengeOptions - -
- Returns Promise<void> -
-
-
-
- sendSMSCode -
-
- sendSMSCode:
- ((parameters) => Promise<void>)
-
-
-
- - Start the passwordless SMS login flow. See - Auth#passwordlessWithSMS -
-
-
-
-
- Type declaration
--
-
-
-
-
-
- - (parameters): Promise<void> - -
-
- --
Parameters
--
-
- - parameters: - PasswordlessWithSMSOptions - -
- Returns Promise<void> -
-
-
-
- user -
- -
-
-
-
- - The user profile as decoded from the ID token after - authentication -
-
-
-
-
-
-
diff --git a/docs/interfaces/UserInfoOptions.html b/docs/interfaces/UserInfoOptions.html
deleted file mode 100644
index e1bc1a52..00000000
--- a/docs/interfaces/UserInfoOptions.html
+++ /dev/null
@@ -1,331 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- is
-
-
-
-
-
-
-
-
-
-
- Interface AuthState<TUser>
-
- interface AuthState<TUser>
- {
error: null | BaseError;
isLoading: boolean;
user: null | TUser;
} -
- error: null | BaseError;
isLoading: boolean;
user: null | TUser;
} -
Type Parameters
- -- Hierarchy (view full) -
--
-
-
- AuthState
-
-
-
- - Auth0ContextInterface - -
-
Properties
-- error -
- -
-
-
-
- An object representing the last exception
-
- is
-
- is
-
-
-
-
- - A flag that is true until the state knows that a user is either - logged in or not -
-- user -
- -
-
-
-
- - The user profile as decoded from the ID token after - authentication -
-
-
-
-
-
-
diff --git a/docs/interfaces/UserInfoOptions.md b/docs/interfaces/UserInfoOptions.md
new file mode 100644
index 00000000..44f64801
--- /dev/null
+++ b/docs/interfaces/UserInfoOptions.md
@@ -0,0 +1,21 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / UserInfoOptions
+
+# Interface: UserInfoOptions
+
+Defined in: [types.ts:512](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L512)
+
+Options for accessing the `/userinfo` endpoint.
+
+## Properties
+
+### token
+
+> **token**: `string`
+
+Defined in: [types.ts:516](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L516)
+
+The user's access token
diff --git a/docs/interfaces/WebAuthorizeOptions.html b/docs/interfaces/WebAuthorizeOptions.html
deleted file mode 100644
index 2b3b939b..00000000
--- a/docs/interfaces/WebAuthorizeOptions.html
+++ /dev/null
@@ -1,636 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface UserInfoOptions
-
-
-
- Options for accessing the /userinfo endpoint.
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- token
-
- Properties
-- token -
-
- token:
- string
-
-
-
-
-
- The user's access token
-
-
-
-
-
-
diff --git a/docs/interfaces/WebAuthorizeOptions.md b/docs/interfaces/WebAuthorizeOptions.md
new file mode 100644
index 00000000..950d67b6
--- /dev/null
+++ b/docs/interfaces/WebAuthorizeOptions.md
@@ -0,0 +1,90 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / WebAuthorizeOptions
+
+# Interface: WebAuthorizeOptions
+
+Defined in: [types.ts:110](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L110)
+
+Options for controlling the SDK's behaviour when calling the `/authorize` endpoint.
+
+## Properties
+
+### customScheme?
+
+> `optional` **customScheme**: `string`
+
+Defined in: [types.ts:124](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L124)
+
+Custom scheme to build the callback URL with.
+
+---
+
+### ephemeralSession?
+
+> `optional` **ephemeralSession**: `boolean`
+
+Defined in: [types.ts:120](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L120)
+
+**iOS only**: Disable Single-Sign-On (SSO). It only affects iOS with versions 13 and above.
+
+#### Default
+
+`false`
+
+---
+
+### leeway?
+
+> `optional` **leeway**: `number`
+
+Defined in: [types.ts:115](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L115)
+
+The amount of leeway, in seconds, to accommodate potential clock skew when validating an ID token's claims.
+
+#### Default
+
+60 seconds.
+
+---
+
+### useLegacyCallbackUrl?
+
+> `optional` **useLegacyCallbackUrl**: `boolean`
+
+Defined in: [types.ts:128](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L128)
+
+This will use older callback URL. See [https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration](https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration) for more details.
+
+---
+
+### useSFSafariViewController?
+
+> `optional` **useSFSafariViewController**: `boolean` \| \{ `presentationStyle`: [`SafariViewControllerPresentationStyle`](../enumerations/SafariViewControllerPresentationStyle.md); \}
+
+Defined in: [types.ts:146](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L146)
+
+**iOS only:** Uses `SFSafariViewController` instead of `ASWebAuthenticationSession`. If empty object is set, the presentationStyle defaults to [SafariViewControllerPresentationStyle.fullScreen](../enumerations/SafariViewControllerPresentationStyle.md#fullscreen)
+
+This can be used as a boolean value or as an object which sets the `presentationStyle`. See the examples below for reference
+
+#### Examples
+
+```typescript
+await authorize({}, { useSFSafariViewController: true });
+```
+
+or
+
+```typescript
+await authorize(
+ {},
+ {
+ useSFSafariViewController: {
+ presentationStyle: SafariViewControllerPresentationStyle.fullScreen,
+ },
+ }
+);
+```
diff --git a/docs/interfaces/WebAuthorizeParameters.html b/docs/interfaces/WebAuthorizeParameters.html
deleted file mode 100644
index 2f250982..00000000
--- a/docs/interfaces/WebAuthorizeParameters.html
+++ /dev/null
@@ -1,862 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface WebAuthorizeOptions
-
-
-
-
- Options for controlling the SDK's behaviour when calling the
- /authorize endpoint.
-
- interface WebAuthorizeOptions
- {
customScheme?: string;
ephemeralSession?: boolean;
leeway?: number;
useLegacyCallbackUrl?: boolean;
useSFSafariViewController?: boolean | {
presentationStyle?: SafariViewControllerPresentationStyle;
};
} -
-
- customScheme?: string;
ephemeralSession?: boolean;
leeway?: number;
useLegacyCallbackUrl?: boolean;
useSFSafariViewController?: boolean | {
presentationStyle?: SafariViewControllerPresentationStyle;
};
} -
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
- -Properties
-
- Optional
- custom
-
- custom
-
-
-
-
- - Android only: Custom scheme to build the - callback URL with. -
-
- Optional
- ephemeral
-
- ephemeral
-
-
- - iOS only: Disable Single-Sign-On (SSO). It only - affects iOS with versions 13 and above. -
-
-
-
- Default
-false
- Optional
- leeway
-
-
- leeway?:
- number
-
-
-
- - The amount of leeway, in seconds, to accommodate potential clock - skew when validating an ID token's claims. -
-
-
-
- Default
-60 seconds.
-
- Optional
- use
-
- use
-
-
-
-
- - This will use older callback URL. See - https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration - for more details. -
-
- Optional
- useSFSafari
-
- useSFSafari
presentationStyle?: SafariViewControllerPresentationStyle;
} -
- presentationStyle?: SafariViewControllerPresentationStyle;
} -
-
-
- iOS only: Uses
- SFSafariViewController instead of
- ASWebAuthenticationSession. If empty object is set,
- the presentationStyle defaults to
- SafariViewControllerPresentationStyle.fullScreen
-
- This can be used as a boolean value or as an object which sets
- the presentationStyle. See the examples below for
- reference
-
-
- Type declaration
--
-
-
-
-
-Optional- presentationStyle?: SafariViewControllerPresentationStyle -
-
-
-
- Example
-await authorize({}, {useSFSafariViewController: true});
-or
-Example
-await authorize({}, {useSFSafariViewController: {presentationStyle: SafariViewControllerPresentationStyle.fullScreen}});
-
-
-
-
-
-
diff --git a/docs/interfaces/WebAuthorizeParameters.md b/docs/interfaces/WebAuthorizeParameters.md
new file mode 100644
index 00000000..f2dca379
--- /dev/null
+++ b/docs/interfaces/WebAuthorizeParameters.md
@@ -0,0 +1,123 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / WebAuthorizeParameters
+
+# Interface: WebAuthorizeParameters
+
+Defined in: [types.ts:56](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L56)
+
+Parameters that are sent to a call to the `/authorize` endpoint.
+
+## Properties
+
+### additionalParameters?
+
+> `optional` **additionalParameters**: `object`
+
+Defined in: [types.ts:104](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L104)
+
+Any additional arbitrary parameters to send along in the URL.
+
+#### Index Signature
+
+\[`key`: `string`\]: `string`
+
+---
+
+### audience?
+
+> `optional` **audience**: `string`
+
+Defined in: [types.ts:68](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L68)
+
+The intended API identifier that will be the consumer for the issued access token.
+
+---
+
+### connection?
+
+> `optional` **connection**: `string`
+
+Defined in: [types.ts:76](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L76)
+
+The database connection in which to look for users.
+
+---
+
+### invitationUrl?
+
+> `optional` **invitationUrl**: `string`
+
+Defined in: [types.ts:88](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L88)
+
+The invitation URL for those users who have been invited to join a specific organization.
+
+---
+
+### maxAge?
+
+> `optional` **maxAge**: `number`
+
+Defined in: [types.ts:80](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L80)
+
+The maximum age in seconds that the resulting ID token should be issued for.
+
+---
+
+### nonce?
+
+> `optional` **nonce**: `string`
+
+Defined in: [types.ts:64](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L64)
+
+One-time random value that is used to prevent replay attacks.
+
+---
+
+### organization?
+
+> `optional` **organization**: `string`
+
+Defined in: [types.ts:84](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L84)
+
+The organization in which user's should be authenticated into.
+
+---
+
+### redirectUrl?
+
+> `optional` **redirectUrl**: `string`
+
+Defined in: [types.ts:100](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L100)
+
+Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.
+
+If you are using this, ensure a proper redirect URL is constructed in the following format
+Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+
+If you have `useLegacyCallbackUrl` set to true then the redirect URL should in the format
+Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:72](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L72)
+
+The scopes requested for the issued tokens. e.g. `openid profile`
+
+---
+
+### state?
+
+> `optional` **state**: `string`
+
+Defined in: [types.ts:60](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L60)
+
+Random string to prevent CSRF attacks.
diff --git a/docs/modules.html b/docs/modules.html
deleted file mode 100644
index 14b9fc00..00000000
--- a/docs/modules.html
+++ /dev/null
@@ -1,511 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Interface WebAuthorizeParameters
-
-
-
-
- Parameters that are sent to a call to the
- /authorize endpoint.
-
- interface WebAuthorizeParameters
- {
additionalParameters?: {
[key: - string]: string;
};
audience?: string;
connection?: string;
invitationUrl?: string;
maxAge?: number;
nonce?: string;
organization?: string;
redirectUrl?: string;
scope?: string;
state?: string;
} -
-
- additionalParameters?: {
[key: - string]: string;
};
audience?: string;
connection?: string;
invitationUrl?: string;
maxAge?: number;
nonce?: string;
organization?: string;
redirectUrl?: string;
scope?: string;
state?: string;
} -
-
-
-
-
-
-
- Index
-
-
-
-
-
-
- Properties
-
- additional
- Properties
-
- Optional
- additional
-
- additional
[key: - string]: string;
} -
- [key: - string]: string;
} -
-
- - Any additional arbitrary parameters to send along in the URL. -
-
-
-
-
- Type declaration
--
-
-
-
- [key: - string]: string -
-
-
- Optional
- audience
-
-
- audience?:
- string
-
-
-
-
-
- - The intended API identifier that will be the consumer for the - issued access token. -
-
- Optional
- connection
-
-
- connection?:
- string
-
-
-
-
-
- The database connection in which to look for users.
-
- Optional
- invitation
-
- invitation
-
-
-
-
- - The invitation URL for those users who have been invited to join - a specific organization. -
-
- Optional
- max
-
- max
-
-
-
-
- - The maximum age in seconds that the resulting ID token should be - issued for. -
-
- Optional
- nonce
-
-
- nonce?:
- string
-
-
-
-
-
- - One-time random value that is used to prevent replay attacks. -
-
- Optional
- organization
-
-
- organization?:
- string
-
-
-
-
-
- - The organization in which user's should be authenticated - into. -
-
- Optional
- redirect
-
- redirect
-
-
-
-
- - Specify a custom redirect URL to be used. Normally, you - wouldn't need to call this method manually as the default - value is autogenerated for you. -
-- If you are using this, ensure a proper redirect URL is - constructed in the following format Android: - {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -
-
- If you have useLegacyCallbackUrl set to true then
- the redirect URL should in the format Android:
- {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
- iOS:
- {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
-
- Optional
- scope
-
-
- scope?:
- string
-
-
-
-
-
-
- The scopes requested for the issued tokens. e.g.
- openid profile
-
- Optional
- state
-
-
- state?:
- string
-
-
-
-
-
- Random string to prevent CSRF attacks.
-
-
-
-
-
-
diff --git a/docs/modules/Types.html b/docs/modules/Types.html
deleted file mode 100644
index fcfb7c6c..00000000
--- a/docs/modules/Types.html
+++ /dev/null
@@ -1,294 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- react-native-auth0
Index
-Modules
-
- Types
-
- Enumerations
- -Classes
-
- Timeout
- Interfaces
-
- Authorize
- Type Aliases
- -Functions
-
- Auth0
-
-
-
-
-
-
diff --git a/docs/type-aliases/Credentials.md b/docs/type-aliases/Credentials.md
new file mode 100644
index 00000000..29001675
--- /dev/null
+++ b/docs/type-aliases/Credentials.md
@@ -0,0 +1,75 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / Credentials
+
+# Type Alias: Credentials
+
+> **Credentials** = `object`
+
+Defined in: [types.ts:1](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L1)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### accessToken
+
+> **accessToken**: `string`
+
+Defined in: [types.ts:9](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L9)
+
+The token used to make API calls
+
+---
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: [types.ts:17](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L17)
+
+Used to denote when the token will expire, as a UNIX timestamp
+
+---
+
+### idToken
+
+> **idToken**: `string`
+
+Defined in: [types.ts:5](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L5)
+
+A token in JWT format that has user claims
+
+---
+
+### refreshToken?
+
+> `optional` **refreshToken**: `string`
+
+Defined in: [types.ts:21](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L21)
+
+The token used to refresh the access token
+
+---
+
+### scope?
+
+> `optional` **scope**: `string`
+
+Defined in: [types.ts:25](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L25)
+
+Represents the scope of the current token
+
+---
+
+### tokenType
+
+> **tokenType**: `string`
+
+Defined in: [types.ts:13](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L13)
+
+The type of the token, e.g.: Bearer
diff --git a/docs/type-aliases/MultifactorChallengeOOBResponse.md b/docs/type-aliases/MultifactorChallengeOOBResponse.md
new file mode 100644
index 00000000..a9394ba7
--- /dev/null
+++ b/docs/type-aliases/MultifactorChallengeOOBResponse.md
@@ -0,0 +1,17 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / MultifactorChallengeOOBResponse
+
+# Type Alias: MultifactorChallengeOOBResponse
+
+> **MultifactorChallengeOOBResponse** = [`MultifactorChallengeOTPResponse`](MultifactorChallengeOTPResponse.md) & `object`
+
+Defined in: [types.ts:583](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L583)
+
+## Type declaration
+
+### oobCode
+
+> **oobCode**: `string`
diff --git a/docs/type-aliases/MultifactorChallengeOOBWithBindingResponse.md b/docs/type-aliases/MultifactorChallengeOOBWithBindingResponse.md
new file mode 100644
index 00000000..bcb8548f
--- /dev/null
+++ b/docs/type-aliases/MultifactorChallengeOOBWithBindingResponse.md
@@ -0,0 +1,17 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / MultifactorChallengeOOBWithBindingResponse
+
+# Type Alias: MultifactorChallengeOOBWithBindingResponse
+
+> **MultifactorChallengeOOBWithBindingResponse** = [`MultifactorChallengeOOBResponse`](MultifactorChallengeOOBResponse.md) & `object`
+
+Defined in: [types.ts:587](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L587)
+
+## Type declaration
+
+### bindingMethod
+
+> **bindingMethod**: `string`
diff --git a/docs/type-aliases/MultifactorChallengeOTPResponse.md b/docs/type-aliases/MultifactorChallengeOTPResponse.md
new file mode 100644
index 00000000..4d8e84dd
--- /dev/null
+++ b/docs/type-aliases/MultifactorChallengeOTPResponse.md
@@ -0,0 +1,19 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / MultifactorChallengeOTPResponse
+
+# Type Alias: MultifactorChallengeOTPResponse
+
+> **MultifactorChallengeOTPResponse** = `object`
+
+Defined in: [types.ts:581](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L581)
+
+## Properties
+
+### challengeType
+
+> **challengeType**: `string`
+
+Defined in: [types.ts:581](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L581)
diff --git a/docs/type-aliases/MultifactorChallengeResponse.md b/docs/type-aliases/MultifactorChallengeResponse.md
new file mode 100644
index 00000000..59da4b32
--- /dev/null
+++ b/docs/type-aliases/MultifactorChallengeResponse.md
@@ -0,0 +1,11 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / MultifactorChallengeResponse
+
+# Type Alias: MultifactorChallengeResponse
+
+> **MultifactorChallengeResponse** = [`MultifactorChallengeOTPResponse`](MultifactorChallengeOTPResponse.md) \| [`MultifactorChallengeOOBResponse`](MultifactorChallengeOOBResponse.md) \| [`MultifactorChallengeOOBWithBindingResponse`](MultifactorChallengeOOBWithBindingResponse.md)
+
+Defined in: [types.ts:592](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L592)
diff --git a/docs/type-aliases/User.md b/docs/type-aliases/User.md
new file mode 100644
index 00000000..5cf672ba
--- /dev/null
+++ b/docs/type-aliases/User.md
@@ -0,0 +1,175 @@
+[**react-native-auth0**](../README.md)
+
+---
+
+[react-native-auth0](../globals.md) / User
+
+# Type Alias: User
+
+> **User** = `object`
+
+Defined in: [types.ts:29](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L29)
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+## Properties
+
+### address?
+
+> `optional` **address**: `string`
+
+Defined in: [types.ts:47](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L47)
+
+---
+
+### birthdate?
+
+> `optional` **birthdate**: `string`
+
+Defined in: [types.ts:42](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L42)
+
+---
+
+### email?
+
+> `optional` **email**: `string`
+
+Defined in: [types.ts:39](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L39)
+
+---
+
+### emailVerified?
+
+> `optional` **emailVerified**: `boolean`
+
+Defined in: [types.ts:40](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L40)
+
+---
+
+### familyName?
+
+> `optional` **familyName**: `string`
+
+Defined in: [types.ts:32](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L32)
+
+---
+
+### gender?
+
+> `optional` **gender**: `string`
+
+Defined in: [types.ts:41](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L41)
+
+---
+
+### givenName?
+
+> `optional` **givenName**: `string`
+
+Defined in: [types.ts:31](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L31)
+
+---
+
+### locale?
+
+> `optional` **locale**: `string`
+
+Defined in: [types.ts:44](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L44)
+
+---
+
+### middleName?
+
+> `optional` **middleName**: `string`
+
+Defined in: [types.ts:33](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L33)
+
+---
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [types.ts:30](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L30)
+
+---
+
+### nickname?
+
+> `optional` **nickname**: `string`
+
+Defined in: [types.ts:34](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L34)
+
+---
+
+### phoneNumber?
+
+> `optional` **phoneNumber**: `string`
+
+Defined in: [types.ts:45](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L45)
+
+---
+
+### phoneNumberVerified?
+
+> `optional` **phoneNumberVerified**: `boolean`
+
+Defined in: [types.ts:46](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L46)
+
+---
+
+### picture?
+
+> `optional` **picture**: `string`
+
+Defined in: [types.ts:37](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L37)
+
+---
+
+### preferredUsername?
+
+> `optional` **preferredUsername**: `string`
+
+Defined in: [types.ts:35](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L35)
+
+---
+
+### profile?
+
+> `optional` **profile**: `string`
+
+Defined in: [types.ts:36](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L36)
+
+---
+
+### sub?
+
+> `optional` **sub**: `string`
+
+Defined in: [types.ts:49](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L49)
+
+---
+
+### updatedAt?
+
+> `optional` **updatedAt**: `string`
+
+Defined in: [types.ts:48](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L48)
+
+---
+
+### website?
+
+> `optional` **website**: `string`
+
+Defined in: [types.ts:38](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L38)
+
+---
+
+### zoneinfo?
+
+> `optional` **zoneinfo**: `string`
+
+Defined in: [types.ts:43](https://github.com/auth0/react-native-auth0/blob/64b3136e2ba68da80f979438fc7bc3abab9becdd/src/types.ts#L43)
diff --git a/docs/types/Credentials.html b/docs/types/Credentials.html
deleted file mode 100644
index 5c325978..00000000
--- a/docs/types/Credentials.html
+++ /dev/null
@@ -1,354 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Module Types
-Index
-Classes
- -Interfaces
- -Type Aliases
-
- Auth0
-
-
-
-
-
-
diff --git a/docs/types/MultifactorChallengeOOBResponse.html b/docs/types/MultifactorChallengeOOBResponse.html
deleted file mode 100644
index aac664cb..00000000
--- a/docs/types/MultifactorChallengeOOBResponse.html
+++ /dev/null
@@ -1,266 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- Type alias Credentials
-
- Credentials:
- {
accessToken: string;
expiresAt: number;
idToken: string;
refreshToken?: string;
scope?: string;
tokenType: string;
[key: - string]: any;
} -
- accessToken: string;
expiresAt: number;
idToken: string;
refreshToken?: string;
scope?: string;
tokenType: string;
[key: - string]: any;
} -
-
-
- Type declaration
--
-
-
-
- [key: - string]: any -
-
- -
-
- access
-Token: string - -- -The token used to make API calls
-
- -
-
- expires
-At: number - -- -- Used to denote when the token will expire, as a UNIX timestamp -
-
- -
-
- id
-Token: string - -- -A token in JWT format that has user claims
-
- -
-
-
-Optional- refreshToken?: string - -- -The token used to refresh the access token
-
- -
-
-
-Optional- scope?: string --- -Represents the scope of the current token
-
- -
-
- token
-Type: string - -- -The type of the token, e.g.: Bearer
-
-
-
-
-
-
-
diff --git a/docs/types/MultifactorChallengeOOBWithBindingResponse.html b/docs/types/MultifactorChallengeOOBWithBindingResponse.html
deleted file mode 100644
index 2751e99b..00000000
--- a/docs/types/MultifactorChallengeOOBWithBindingResponse.html
+++ /dev/null
@@ -1,268 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
- Type alias MultifactorChallengeOOBResponse
-
-
-
- Type declaration
--
-
-
-
- oob
-Code: string -
-
-
-
-
-
-
diff --git a/docs/types/MultifactorChallengeOTPResponse.html b/docs/types/MultifactorChallengeOTPResponse.html
deleted file mode 100644
index dd83f6b2..00000000
--- a/docs/types/MultifactorChallengeOTPResponse.html
+++ /dev/null
@@ -1,261 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- Type alias MultifactorChallengeOOBWithBindingResponse
-
- Multifactor
bindingMethod: string;
} -
- bindingMethod: string;
} -
-
-
- Type declaration
--
-
-
-
- binding
-Method: string -
-
-
-
-
-
-
diff --git a/docs/types/MultifactorChallengeResponse.html b/docs/types/MultifactorChallengeResponse.html
deleted file mode 100644
index 2e790d2a..00000000
--- a/docs/types/MultifactorChallengeResponse.html
+++ /dev/null
@@ -1,256 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- Type alias MultifactorChallengeOTPResponse
-
- Multifactor
challengeType: string;
} -
- challengeType: string;
} -
-
-
- Type declaration
--
-
-
-
- challenge
-Type: string -
-
-
-
-
-
-
diff --git a/docs/types/Types.Auth0Response.html b/docs/types/Types.Auth0Response.html
deleted file mode 100644
index b0de9496..00000000
--- a/docs/types/Types.Auth0Response.html
+++ /dev/null
@@ -1,329 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- Type alias MultifactorChallengeResponse
-
- Multifactor
-
-
-
-
-
-
-
diff --git a/docs/types/Types.Telemetry.html b/docs/types/Types.Telemetry.html
deleted file mode 100644
index 53d3544c..00000000
--- a/docs/types/Types.Telemetry.html
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
- Type alias Auth0Response<TData>
-
- Auth0
headers?: Headers;
json?: TData;
ok?: boolean;
status: number;
text?: string;
} -
- headers?: Headers;
json?: TData;
ok?: boolean;
status: number;
text?: string;
} -
Type Parameters
- -
-
-
- Type declaration
--
-
-
-
-
-Optional- headers?: Headers -
- -
-
-
-Optional- json?: TData -
- -
-
-
-Optional- ok?: boolean -
- -
-
- status: number -
-
- -
-
-
-Optional- text?: string -
-
-
-
-
-
-
diff --git a/docs/types/User.html b/docs/types/User.html
deleted file mode 100644
index 1db3328e..00000000
--- a/docs/types/User.html
+++ /dev/null
@@ -1,501 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
- Type alias Telemetry
-
- Telemetry:
- {
env?: any;
name?: string;
version?: string;
} -
- env?: any;
name?: string;
version?: string;
} -
-
-
- Type declaration
--
-
-
-
-
-Optional- env?: any -
- -
-
-
-Optional- name?: string -
- -
-
-
-Optional- version?: string -
-
-
-
-
-
-
diff --git a/package-lock.json b/package-lock.json
index 3b8e2a8b..25f37084 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "react-native-auth0",
- "version": "4.4.0",
+ "version": "4.5.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "react-native-auth0",
- "version": "4.4.0",
+ "version": "4.5.0",
"license": "MIT",
"dependencies": {
"base-64": "^0.1.0",
@@ -59,8 +59,9 @@
"react-native-svg-transformer": "^1.5.0",
"release-it": "^15.0.0",
"semver": "^6.3.0",
- "typedoc": "^0.27.7",
- "typedoc-plugin-missing-exports": "^3.1.0",
+ "typedoc": "^0.28.2",
+ "typedoc-plugin-markdown": "^4.6.2",
+ "typedoc-plugin-missing-exports": "^4.0.0",
"typescript": "5.7.3"
},
"peerDependencies": {
@@ -4371,15 +4372,17 @@
}
},
"node_modules/@gerrit0/mini-shiki": {
- "version": "1.27.2",
- "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-1.27.2.tgz",
- "integrity": "sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og==",
+ "version": "3.2.3",
+ "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.2.3.tgz",
+ "integrity": "sha512-yemSYr0Oiqk5NAQRfbD5DKUTlThiZw1MxTMx/YpQTg6m4QRJDtV2JTYSuNevgx1ayy/O7x+uwDjh3IgECGFY/Q==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/engine-oniguruma": "^1.27.2",
- "@shikijs/types": "^1.27.2",
- "@shikijs/vscode-textmate": "^10.0.1"
+ "@shikijs/engine-oniguruma": "^3.2.2",
+ "@shikijs/langs": "^3.2.2",
+ "@shikijs/themes": "^3.2.2",
+ "@shikijs/types": "^3.2.2",
+ "@shikijs/vscode-textmate": "^10.0.2"
}
},
"node_modules/@hapi/hoek": {
@@ -6301,31 +6304,51 @@
}
},
"node_modules/@shikijs/engine-oniguruma": {
- "version": "1.29.2",
- "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.29.2.tgz",
- "integrity": "sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==",
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.2.2.tgz",
+ "integrity": "sha512-vyXRnWVCSvokwbaUD/8uPn6Gqsf5Hv7XwcW4AgiU4Z2qwy19sdr6VGzMdheKKN58tJOOe5MIKiNb901bgcUXYQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@shikijs/types": "3.2.2",
+ "@shikijs/vscode-textmate": "^10.0.2"
+ }
+ },
+ "node_modules/@shikijs/langs": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.2.2.tgz",
+ "integrity": "sha512-NY0Urg2dV9ETt3JIOWoMPuoDNwte3geLZ4M1nrPHbkDS8dWMpKcEwlqiEIGqtwZNmt5gKyWpR26ln2Bg2ecPgw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@shikijs/types": "3.2.2"
+ }
+ },
+ "node_modules/@shikijs/themes": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.2.2.tgz",
+ "integrity": "sha512-Zuq4lgAxVKkb0FFdhHSdDkALuRpsj1so1JdihjKNQfgM78EHxV2JhO10qPsMrm01FkE3mDRTdF68wfmsqjt6HA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/types": "1.29.2",
- "@shikijs/vscode-textmate": "^10.0.1"
+ "@shikijs/types": "3.2.2"
}
},
"node_modules/@shikijs/types": {
- "version": "1.29.2",
- "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.29.2.tgz",
- "integrity": "sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==",
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.2.2.tgz",
+ "integrity": "sha512-a5TiHk7EH5Lso8sHcLHbVNNhWKP0Wi3yVnXnu73g86n3WoDgEra7n3KszyeCGuyoagspQ2fzvy4cpSc8pKhb0A==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/vscode-textmate": "^10.0.1",
+ "@shikijs/vscode-textmate": "^10.0.2",
"@types/hast": "^3.0.4"
}
},
"node_modules/@shikijs/vscode-textmate": {
- "version": "10.0.1",
- "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.1.tgz",
- "integrity": "sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==",
+ "version": "10.0.2",
+ "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz",
+ "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==",
"dev": true,
"license": "MIT"
},
@@ -25689,36 +25712,50 @@
}
},
"node_modules/typedoc": {
- "version": "0.27.7",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.7.tgz",
- "integrity": "sha512-K/JaUPX18+61W3VXek1cWC5gwmuLvYTOXJzBvD9W7jFvbPnefRnCHQCEPw7MSNrP/Hj7JJrhZtDDLKdcYm6ucg==",
+ "version": "0.28.2",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.2.tgz",
+ "integrity": "sha512-9Giuv+eppFKnJ0oi+vxqLM817b/IrIsEMYgy3jj6zdvppAfDqV3d6DXL2vXUg2TnlL62V48th25Zf/tcQKAJdg==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
- "@gerrit0/mini-shiki": "^1.24.0",
+ "@gerrit0/mini-shiki": "^3.2.2",
"lunr": "^2.3.9",
"markdown-it": "^14.1.0",
"minimatch": "^9.0.5",
- "yaml": "^2.6.1"
+ "yaml": "^2.7.1"
},
"bin": {
"typedoc": "bin/typedoc"
},
+ "engines": {
+ "node": ">= 18",
+ "pnpm": ">= 10"
+ },
+ "peerDependencies": {
+ "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x"
+ }
+ },
+ "node_modules/typedoc-plugin-markdown": {
+ "version": "4.6.2",
+ "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.6.2.tgz",
+ "integrity": "sha512-JVCIoK7FDN3t3PSLkwDyrBFyjtDznqDCJotP9evxhLyb6bEZTqhAGB0tPy1RmgHuY2WoAONMrsWs8LfLsD+A6A==",
+ "dev": true,
+ "license": "MIT",
"engines": {
"node": ">= 18"
},
"peerDependencies": {
- "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x"
+ "typedoc": "0.28.x"
}
},
"node_modules/typedoc-plugin-missing-exports": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-3.1.0.tgz",
- "integrity": "sha512-Sogbaj+qDa21NjB3SlIw4JXSwmcl/WOjwiPNaVEcPhpNG/MiRTtpwV81cT7h1cbu9StpONFPbddYWR0KV/fTWA==",
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-4.0.0.tgz",
+ "integrity": "sha512-Z4ei+853xppDEhcqzyeyRs4+R0kUuKQWnMK1EtSTEd5LFkgkdW5Bdn8vfo/rsCGbYVJxOWU99fxgM1mROw5Fug==",
"dev": true,
"license": "MIT",
"peerDependencies": {
- "typedoc": "0.26.x || 0.27.x"
+ "typedoc": "^0.28.1"
}
},
"node_modules/typedoc/node_modules/brace-expansion": {
@@ -26806,9 +26843,9 @@
"license": "ISC"
},
"node_modules/yaml": {
- "version": "2.7.0",
- "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.0.tgz",
- "integrity": "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==",
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.1.tgz",
+ "integrity": "sha512-10ULxpnOCQXxJvBgxsn9ptjq6uviG/htZKk9veJGhlqn3w/DxQ631zFF+nlQXLwmImeS5amR2dl2U8sg6U9jsQ==",
"dev": true,
"license": "ISC",
"bin": {
diff --git a/package.json b/package.json
index 15c4d130..56a3a672 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "react-native-auth0",
"title": "React Native Auth0",
- "version": "4.4.0",
+ "version": "4.5.0",
"description": "React Native toolkit for Auth0 API",
"main": "lib/commonjs/index.js",
"module": "lib/module/index.js",
@@ -117,8 +117,9 @@
"react-native-svg-transformer": "^1.5.0",
"release-it": "^15.0.0",
"semver": "^6.3.0",
- "typedoc": "^0.27.7",
- "typedoc-plugin-missing-exports": "^3.1.0",
+ "typedoc": "^0.28.2",
+ "typedoc-plugin-markdown": "^4.6.2",
+ "typedoc-plugin-missing-exports": "^4.0.0",
"typescript": "5.7.3"
},
"dependencies": {
diff --git a/typedoc.json b/typedoc.json
index 0888ff82..955c061e 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -2,7 +2,7 @@
"entryPoints": ["src/index.ts"],
"out": "out",
"jsDocCompatibility": false,
- "plugin": ["typedoc-plugin-missing-exports"],
+ "plugin": ["typedoc-plugin-missing-exports", "typedoc-plugin-markdown"],
"exclude": ["./src/internal-types.ts", "./src/webauth/agent.ts"],
"excludeExternals": true,
"internalModule": "Types"
-
-
-
-
-
- Type alias User
-
- User:
- {
address?: string;
birthdate?: string;
email?: string;
emailVerified?: boolean;
familyName?: string;
gender?: string;
givenName?: string;
locale?: string;
middleName?: string;
name?: string;
nickname?: string;
phoneNumber?: string;
phoneNumberVerified?: boolean;
picture?: string;
preferredUsername?: string;
profile?: string;
sub?: string;
updatedAt?: string;
website?: string;
zoneinfo?: string;
[key: - string]: any;
} -
- address?: string;
birthdate?: string;
email?: string;
emailVerified?: boolean;
familyName?: string;
gender?: string;
givenName?: string;
locale?: string;
middleName?: string;
name?: string;
nickname?: string;
phoneNumber?: string;
phoneNumberVerified?: boolean;
picture?: string;
preferredUsername?: string;
profile?: string;
sub?: string;
updatedAt?: string;
website?: string;
zoneinfo?: string;
[key: - string]: any;
} -
-
-
- Type declaration
--
-
-
-
- [key: - string]: any -
-
- -
-
-
-Optional- address?: string -
- -
-
-
-Optional- birthdate?: string -
- -
-
-
-Optional- email?: string -
- -
-
-
-Optional- emailVerified?: boolean -
- -
-
-
-Optional- familyName?: string -
- -
-
-
-Optional- gender?: string -
- -
-
-
-Optional- givenName?: string -
- -
-
-
-Optional- locale?: string -
- -
-
-
-Optional- middleName?: string -
- -
-
-
-Optional- name?: string -
- -
-
-
-Optional- nickname?: string -
- -
-
-
-Optional- phoneNumber?: string -
- -
-
-
-Optional- phoneNumber Verified?: boolean -
- -
-
-
-Optional- picture?: string -
- -
-
-
-Optional- preferredUsername?: string -
- -
-
-
-Optional- profile?: string -
- -
-
-
-Optional- sub?: string -
- -
-
-
-Optional- updatedAt?: string -
- -
-
-
-Optional- website?: string -
- -
-
-
-Optional- zoneinfo?: string -
-
- Class for interfacing with the Auth0 Authentication API endpoints. -
-See
-- https://auth0.com/docs/api/authentication -
-