{"id":18825526,"url":"https://github.com/outsystems/cordova-plugin-fingerprint","last_synced_at":"2025-04-14T01:31:27.938Z","repository":{"id":11990603,"uuid":"70912915","full_name":"OutSystems/cordova-plugin-fingerprint","owner":"OutSystems","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-11T11:57:12.000Z","size":63,"stargazers_count":4,"open_issues_count":3,"forks_count":13,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-03-27T15:52:18.809Z","etag":null,"topics":["cordova-plugin","engineering","mabs","odc","snyk-mobile","ssdlc-rules","supported-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OutSystems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-14T13:30:59.000Z","updated_at":"2024-12-11T11:54:48.000Z","dependencies_parsed_at":"2024-12-04T18:29:25.455Z","dependency_job_id":"b7977cec-f161-40a9-854b-b3b7b6f39f8b","html_url":"https://github.com/OutSystems/cordova-plugin-fingerprint","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-fingerprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-fingerprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-fingerprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OutSystems%2Fcordova-plugin-fingerprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OutSystems","download_url":"https://codeload.github.com/OutSystems/cordova-plugin-fingerprint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248807573,"owners_count":21164711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cordova-plugin","engineering","mabs","odc","snyk-mobile","ssdlc-rules","supported-plugin"],"created_at":"2024-11-08T00:59:50.595Z","updated_at":"2025-04-14T01:31:27.656Z","avatar_url":"https://github.com/OutSystems.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OutSystems Finger Print cordova plugin\n\n  Cordova Plugin to leverage the local authentication framework to allow in-app user authentication using Touch ID.\n\n:warning: This plugin is SUPPORTED by OutSystems. Customers entitled to Support Services may obtain assistance through Support.\n\n## Supported Platforms\n\n  - iOS\n  - Android\n\n## Dependencies \n\n  - cordova-plugin-fingerprint-aio\n  - cordova-plugin-touchid\n\n## Installation\n  - Run the following command:\n\n ```shell\n      cordova plugin add https://bitbucket.org/uxmobile/fingerprint-cordova-plugin.git\n  ```\n#Setup for Android\n  Add preference to mobile-config.js\n  \n  ```\n  App.setPreference('android-targetSdkVersion', '23');\n  ```\n\n  set compile version and build tools in build.gradle\n  \n  ```\n  compileSdkVersion 23\n  buildToolsVersion \"23.0.2\"\n  ```\n\n## Usage\n\n  You **do not** need to reference any JavaScript, the Cordova plugin architecture will add a touchid object to your root automatically when you build.\n\n  Ensure you use the plugin after your deviceready event has been fired.\n\n### Authenticate\n\n  Pass the following arguments to the `authenticate()` function, to prompt the user to authenticate via TouchID:\n\n  1. Success callback (called on successful authentication)\n  2. Failure callback (called on error or if authentication fails)\n  3. Object with configuration*\n\n  ```\n  touchid.authenticate(successCallback, failureCallback, object);\n  ```\n\n#### Config Object for\n  | Param | Type | Default | Description |\n  | --- | --- | --- | --- |\n  | clientId | String | undefined | (REQUIRED) Used as the alias for your key in the Android Key Store. |\n  | clientSecret | String | undefined | (REQUIRED) Used to encrypt the token returned upon successful fingerprint authentication. |\n  | disableBackup | boolean | false | Set to true to remove the \"USE BACKUP\" button |\n  | maxAttempts | number | 5 | The device max is 5 attempts.  Set this parameter if you want to allow fewer than 5 attempts.  |\n  | locale | String | \"en_US\" | Change the language displayed on the authentication dialog.\u003cbr/\u003e\u003cul\u003e\u003cli\u003eEnglish: \"en_US\"\u003c/li\u003e\u003cli\u003eSpanish: \"es\"\u003c/li\u003e\u003cli\u003eRussian: \"ru\"\u003c/li\u003e\u003cli\u003eFrench: \"fr\"\u003c/li\u003e\u003cli\u003eChinese (Simplified): \u003cul\u003e\u003cli\u003e\"zh_CN\"\u003c/li\u003e\u003cli\u003e\"zh_SG\"\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003eChinese (Traditional): \u003cul\u003e\u003cli\u003e\"zh\"\u003c/li\u003e\u003cli\u003e\"zh_HK\"\u003c/li\u003e\u003cli\u003e\"zh_TW\"\u003c/li\u003e\u003cli\u003e\"zh_MO\"\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003eNorwegian: \"no\"\u003c/li\u003e\u003c/ul\u003e |\n  | userAuthRequired | boolean | true | Require the user to authenticate with a fingerprint to authorize every use of the key.  New fingerprint enrollment will invalidate key and require backup authenticate to re-enable the fingerprint authentication dialog. |\n  | dialogTitle | String | undefined | Set the title of the fingerprint authentication dialog. |\n  | dialogMessage | String | undefined | (REQUIRED) Set the message of the fingerprint authentication dialog. |\n  | dialogHint | String | undefined | Set the hint displayed by the fingerprint icon on the fingerprint authentication dialog. |\n\n\n*NOTE: The dialogMessage you present to the user should provide a clear reason for why you are requesting they authenticate themselves, and what action you will be taking based on that authentication.\n\n### Check support\n\n  Although the `authenticate()` function will return an error if the user is unable to authenticate via Touch ID, you may wish to check support without prompting the user to authenticate. This can be done by passing following arguments to the `checkSupport()` function:\n\n  1. Success callback (called if authentication is possible)\n  2. Not supported callback (called if policy can not be evaluated, with error message)\n\n  ```\n  touchid.checkSupport(successCallback, notSupportedCallback);\n  ```\n\n## Platforms\n\n  iOS 8+\n  Android 23+\n\n#### Contributors\n  - Domingos Gomes, \u003cdomingos.gomes@outsystems.com\u003e\n#### Document author\n  - Domingos Gomes, \u003cdomingos.gomes@outsystems.com\u003e\n\n### Copyright OutSystems, 2016\n\n---\n\nLICENSE\n=======\n\n\n[The MIT License (MIT)](http://www.opensource.org/licenses/mit-license.html)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutsystems%2Fcordova-plugin-fingerprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutsystems%2Fcordova-plugin-fingerprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutsystems%2Fcordova-plugin-fingerprint/lists"}