Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added deviceCredentialFallback default value #1098

Merged
merged 3 commits into from
Mar 18, 2025
Merged

Added deviceCredentialFallback default value #1098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
add30b5
Added deviceCredentialFallback default value
subhankarmaiti Mar 11, 2025
e934c0c
fix: unit test cases
subhankarmaiti Mar 11, 2025
e75adfc
Merge branch 'master' of https://github.com/auth0/react-native-auth0 …
subhankarmaiti Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,16 +468,16 @@ The options for configuring the display of local authentication prompt, authenti

**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 |
| 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. Defaults to `false` | Android |

> :warning: You need a real device to test Local Authentication for iOS. Local Authentication is not available in simulators.

Expand Down
3 changes: 3 additions & 0 deletions src/utils/__tests__/addDefaultLocalAuthOptions.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ describe('addDefaultLocalAuthenticationOptions', () => {
title: 'Please authenticate',
authenticationLevel: LocalAuthenticationLevel.strong,
evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
deviceCredentialFallback: false,
});
});

Expand All @@ -18,6 +19,7 @@ describe('addDefaultLocalAuthenticationOptions', () => {
title: 'Please authenticate',
authenticationLevel: LocalAuthenticationLevel.deviceCredential,
evaluationPolicy: LocalAuthenticationStrategy.deviceOwner,
deviceCredentialFallback: false,
};
const result = addDefaultLocalAuthOptions(localAuthOptions);
expect(result).toEqual(localAuthOptions);
Expand All @@ -33,6 +35,7 @@ describe('addDefaultLocalAuthenticationOptions', () => {
title: 'Please authenticate',
authenticationLevel: LocalAuthenticationLevel.deviceCredential,
evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
deviceCredentialFallback: false,
});
});
});
1 change: 1 addition & 0 deletions src/utils/addDefaultLocalAuthOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import LocalAuthenticationLevel from '../credentials-manager/localAuthentication
const defaultLocalAuthOptions = {
evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
authenticationLevel: LocalAuthenticationLevel.strong,
deviceCredentialFallback: false,
};

function addDefaultLocalAuthOptions(
Expand Down
Loading