{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"SDK Reference","type":"markdown"},"seo":{"title":"Functions","description":"Everything about Mosaic Journeys, SDKs, and APIs","siteUrl":"https://developer.transmitsecurity.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"functions","__idx":0},"children":["Functions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All methods are exposed on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cordova.tsauth"]}," object, which is available after the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceready"]}," event. Every method except ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#isusercanceled"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isUserCanceled"]}]}," returns a Promise."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":1},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rejections always use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ code, platformCode, message }"]},". Branch on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-authentication/enums/errors"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ERRORS"]}]},"). Log ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["platformCode"]},", which is the native SDK's own name. When a platform error has no mapping, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," is the raw ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["platformCode"]}," rather than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["internalError"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"initializesdk","__idx":2},"children":["initializeSDK"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["initializeSDK"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["configurationFile?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initializes the plugin from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmitSecurity.plist"]}," on iOS or from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["strings.xml"]}," on Android. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["configurationFile"]}," is the iOS plist basename and defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmitSecurity"]},". Android ignores it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":3},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["configurationFile?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["iOS plist basename. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmitSecurity"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns","__idx":4},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resolves with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":5},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"await cordova.tsauth.initializeSDK();\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"initialize","__idx":6},"children":["initialize"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["initialize"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initializes the plugin with an explicit client ID. Use this when credentials are not read from the native config file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":7},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Client ID from the app in the Admin Portal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-authentication/interfaces/initializeoptions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InitializeOptions"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Base URL, relying-party domain, and optional WebAuthn API paths"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-1","__idx":8},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resolves with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1","__idx":9},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"await cordova.tsauth.initialize('YOUR_CLIENT_ID', {\n baseUrl: 'https://api.transmitsecurity.io/',\n domain: 'your-domain.com',\n});\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"setloggingenabled","__idx":10},"children":["setLoggingEnabled"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["setLoggingEnabled"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Turns native and JavaScript logging on or off. Logging is off by default."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-2","__idx":11},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," enables logging"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-2","__idx":12},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resolves with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-2","__idx":13},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"await cordova.tsauth.setLoggingEnabled(true);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"iswebauthnsupported","__idx":14},"children":["isWebAuthnSupported"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["isWebAuthnSupported"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reports whether this device and OS can use passkeys. Check this before offering passkey registration or authentication."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-3","__idx":15},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-3","__idx":16},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"if (await cordova.tsauth.isWebAuthnSupported()) {\n await cordova.tsauth.registerWebAuthn('alice@example.com', 'Alice');\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"registerwebauthn","__idx":17},"children":["registerWebAuthn"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["registerWebAuthn"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Registers a passkey for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},". POST ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}," to your backend, or pass it to an Orchestration journey with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-identity-orchestration/functions#submitclientresponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["submitClientResponse"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-3","__idx":18},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User identifier in your system, such as an email address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Display name for the credential"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-4","__idx":19},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}," is the encoded credential."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-4","__idx":20},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.registerWebAuthn('alice@example.com', 'Alice');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"registerwebauthnwithdata","__idx":21},"children":["registerWebAuthnWithData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["registerWebAuthnWithData"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registrationData"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Registers a passkey from a server-provided WebAuthn registration payload, for flows where your backend already called start-registration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-4","__idx":22},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registrationData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Server WebAuthn payload, as an object or a JSON string"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-5","__idx":23},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-5","__idx":24},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.registerWebAuthnWithData(registrationData);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authenticatewebauthn","__idx":25},"children":["authenticateWebAuthn"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authenticateWebAuthn"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authenticates with a passkey. Pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["''"]}," to let the platform offer any local passkey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-5","__idx":26},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Username bound to the passkey, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["''"]}," for any local passkey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-6","__idx":27},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-6","__idx":28},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.authenticateWebAuthn('alice@example.com');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authenticatewebauthnwithdata","__idx":29},"children":["authenticateWebAuthnWithData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authenticateWebAuthnWithData"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authenticates from a server-provided WebAuthn authentication payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-6","__idx":30},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Server WebAuthn payload, as an object or a JSON string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-7","__idx":31},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-7","__idx":32},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.authenticateWebAuthnWithData(authenticationData);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"signwebauthntransaction","__idx":33},"children":["signWebAuthnTransaction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["signWebAuthnTransaction"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs a transaction with a passkey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-7","__idx":34},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Username bound to the passkey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-8","__idx":35},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-8","__idx":36},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.signWebAuthnTransaction('alice@example.com');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"signwebauthntransactionwithdata","__idx":37},"children":["signWebAuthnTransactionWithData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["signWebAuthnTransactionWithData"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs a transaction from a server-provided WebAuthn authentication payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-8","__idx":38},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Server WebAuthn payload, as an object or a JSON string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-9","__idx":39},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-9","__idx":40},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.signWebAuthnTransactionWithData(authenticationData);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"approvalwebauthn","__idx":41},"children":["approvalWebAuthn"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["approvalWebAuthn"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username?"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs a cross-device approval with a passkey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-9","__idx":42},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String-to-string map describing what is approved"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Username bound to the passkey"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-10","__idx":43},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-10","__idx":44},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.approvalWebAuthn(approvalData, 'alice@example.com');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"approvalwebauthnwithdata","__idx":45},"children":["approvalWebAuthnWithData"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["approvalWebAuthnWithData"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Runs a cross-device approval from a server-provided WebAuthn authentication payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-10","__idx":46},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticationData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Server WebAuthn payload, as an object or a JSON string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["options?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ preferLocalCredentials: true }"]}," is iOS only and is ignored on Android"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-11","__idx":47},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ result: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-11","__idx":48},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { result } = await cordova.tsauth.approvalWebAuthnWithData(authenticationData);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"registernativebiometrics","__idx":49},"children":["registerNativeBiometrics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["registerNativeBiometrics"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enrolls the device biometric key for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-11","__idx":50},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User to associate with the biometric key"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-12","__idx":51},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, publicKey: string, keyType: string, attestation: string, os: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-12","__idx":52},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const registration = await cordova.tsauth.registerNativeBiometrics('alice@example.com');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authenticatenativebiometrics","__idx":53},"children":["authenticateNativeBiometrics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authenticateNativeBiometrics"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["promptTexts?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}," with the device biometric key and prompts the user. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["promptTexts"]}," applies on Android. iOS uses the system Face ID or Touch ID prompt and ignores ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["promptTexts"]},". The plugin supplies default prompt text."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-12","__idx":54},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User whose biometric key signs the challenge"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Challenge to sign"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["promptTexts?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-authentication/interfaces/prompttexts"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PromptTexts"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Android prompt title, subtitle, and negative button"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-13","__idx":55},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, signature: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-13","__idx":56},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const signed = await cordova.tsauth.authenticateNativeBiometrics(\n 'alice@example.com',\n challenge\n);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"approvalnativebiometrics","__idx":57},"children":["approvalNativeBiometrics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["approvalNativeBiometrics"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["promptTexts?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}," for an out-of-band approval. Same parameters and return value as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#authenticatenativebiometrics"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authenticateNativeBiometrics"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-14","__idx":58},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const signed = await cordova.tsauth.approvalNativeBiometrics('alice@example.com', challenge);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unregisternativebiometrics","__idx":59},"children":["unregisterNativeBiometrics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unregisterNativeBiometrics"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Removes the device biometric key for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-13","__idx":60},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User whose biometric key is removed"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-14","__idx":61},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-15","__idx":62},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const removed = await cordova.tsauth.unregisterNativeBiometrics('alice@example.com');\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getnativebiometricsstatus","__idx":63},"children":["getNativeBiometricsStatus"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getNativeBiometricsStatus"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reports whether biometrics can be used on this device right now."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-15","__idx":64},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ status: string, statusRaw: string, enrolled: boolean, type: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is one of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-authentication/enums/biometricsstatus"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BIOMETRICS_STATUS"]}]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["faceID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["touchID"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["opticID"]}," on iOS, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["biometric"]}," on Android. The plugin can also return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-16","__idx":65},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const bio = await cordova.tsauth.getNativeBiometricsStatus();\nif (bio.status !== cordova.tsauth.BIOMETRICS_STATUS.AVAILABLE) {\n // Offer PIN or a passkey instead\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"registerpincode","__idx":66},"children":["registerPinCode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["registerPinCode"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pinCode"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Starts PIN registration. The registration is held in memory and becomes durable only after ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#commitpinregistration"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitPinRegistration"]}]},". Commit after your backend has accepted the public key."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the app restarts before commit, the context identifier is gone and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitPinRegistration"]}," rejects with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalidArgs"]},". Start registration again."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-14","__idx":67},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User who owns the PIN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pinCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["PIN to register"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-16","__idx":68},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, publicKey: string, keyType: string, aliasDeviceName: string, contextIdentifier: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-17","__idx":69},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const reg = await cordova.tsauth.registerPinCode('alice', '1234');\nawait myBackend.storePublicKey(reg.publicKey, reg.publicKeyId);\nawait cordova.tsauth.commitPinRegistration(reg.contextIdentifier);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitpinregistration","__idx":70},"children":["commitPinRegistration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["commitPinRegistration"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finalizes a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#registerpincode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registerPinCode"]}]}," call after the backend has accepted the public key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-15","__idx":71},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]}," returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registerPinCode"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-17","__idx":72},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resolves with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-18","__idx":73},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"await cordova.tsauth.commitPinRegistration(reg.contextIdentifier);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authenticatepincode","__idx":74},"children":["authenticatePinCode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authenticatePinCode"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pinCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}," with the registered PIN."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-16","__idx":75},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User who owns the PIN"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pinCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["PIN to verify"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Challenge to sign"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-18","__idx":76},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, signature: string, challenge: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-19","__idx":77},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const signed = await cordova.tsauth.authenticatePinCode('alice', '1234', challenge);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unregisterpincode","__idx":78},"children":["unregisterPinCode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["unregisterPinCode"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Starts PIN removal. Call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#commitpinunregistration"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitPinUnregistration"]}]}," with the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]}," to make the removal durable. The same in-memory rule as registration applies."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-17","__idx":79},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["User whose PIN is removed"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-19","__idx":80},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, contextIdentifier: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-20","__idx":81},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const pending = await cordova.tsauth.unregisterPinCode('alice');\nawait cordova.tsauth.commitPinUnregistration(pending.contextIdentifier);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitpinunregistration","__idx":82},"children":["commitPinUnregistration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["commitPinUnregistration"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finalizes ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#unregisterpincode"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unregisterPinCode"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-18","__idx":83},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextIdentifier"]}," returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unregisterPinCode"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-20","__idx":84},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resolves with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-21","__idx":85},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"await cordova.tsauth.commitPinUnregistration(pending.contextIdentifier);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"registertotp","__idx":86},"children":["registerTOTP"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["registerTOTP"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uri"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["securityType?"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Registers a TOTP authenticator from an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["otpauth://"]}," URI. Persist ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]},". Later code generation uses that id. Any ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["securityType"]}," other than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}," prompts the user when a code is generated."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-19","__idx":87},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uri"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["otpauth://"]}," URI"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["securityType?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["One of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-ref/cordova-ts-authentication/enums/totpsecuritytype"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TOTP_SECURITY_TYPE"]}]},". Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-21","__idx":88},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ issuer: string, label: string, uuid: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-22","__idx":89},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const totp = await cordova.tsauth.registerTOTP(\n uri,\n cordova.tsauth.TOTP_SECURITY_TYPE.BIOMETRIC\n);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generatetotpcode","__idx":90},"children":["generateTOTPCode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["generateTOTPCode"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ code: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generates a TOTP code for a registered authenticator."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-20","__idx":91},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]}," returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registerTOTP"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-22","__idx":92},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ code: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-23","__idx":93},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { code } = await cordova.tsauth.generateTOTPCode(uuid);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generatetotpcodewithchallenge","__idx":94},"children":["generateTOTPCodeWithChallenge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["generateTOTPCodeWithChallenge"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ code: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generates a TOTP code bound to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},", for transaction signing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-21","__idx":95},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]}," returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registerTOTP"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Challenge to bind to the code"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-23","__idx":96},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ code: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-24","__idx":97},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { code } = await cordova.tsauth.generateTOTPCodeWithChallenge(uuid, challenge);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getdeviceinfo","__idx":98},"children":["getDeviceInfo"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["getDeviceInfo"]},"(): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the device public key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-24","__idx":99},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ publicKeyId: string, publicKey: string, keyType: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keyType"]}," is present on Android."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-25","__idx":100},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const device = await cordova.tsauth.getDeviceInfo();\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"signwithdevicekey","__idx":101},"children":["signWithDeviceKey"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["signWithDeviceKey"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ signature: string }>"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signs an arbitrary challenge with the device key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-22","__idx":102},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["challenge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Challenge to sign"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-25","__idx":103},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise<{ signature: string }>"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-26","__idx":104},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"const { signature } = await cordova.tsauth.signWithDeviceKey(challenge);\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"isusercanceled","__idx":105},"children":["isUserCanceled"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["isUserCanceled"]},"(",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," when a rejection is the user leaving a prompt. This method is synchronous."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-23","__idx":106},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Rejection ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ code, platformCode, message }"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"returns-26","__idx":107},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-27","__idx":108},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"try {\n await cordova.tsauth.registerWebAuthn('alice@example.com');\n} catch (e) {\n if (cordova.tsauth.isUserCanceled(e)) return;\n console.warn(e.code, e.platformCode, e.message);\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"style","attributes":{},"children":["\ntable th:first-of-type {\n width: 30%;\n}\ntable th:nth-of-type(2) {\n width: 30%;\n}\ntable th:nth-of-type(3) {\n width: 40%;\n}\n"]}]},"headings":[{"value":"Functions","id":"functions","depth":1},{"value":"Error handling","id":"error-handling","depth":2},{"value":"initializeSDK","id":"initializesdk","depth":2},{"value":"Parameters","id":"parameters","depth":3},{"value":"Returns","id":"returns","depth":3},{"value":"Example","id":"example","depth":3},{"value":"initialize","id":"initialize","depth":2},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Returns","id":"returns-1","depth":3},{"value":"Example","id":"example-1","depth":3},{"value":"setLoggingEnabled","id":"setloggingenabled","depth":2},{"value":"Parameters","id":"parameters-2","depth":3},{"value":"Returns","id":"returns-2","depth":3},{"value":"Example","id":"example-2","depth":3},{"value":"isWebAuthnSupported","id":"iswebauthnsupported","depth":2},{"value":"Returns","id":"returns-3","depth":3},{"value":"Example","id":"example-3","depth":3},{"value":"registerWebAuthn","id":"registerwebauthn","depth":2},{"value":"Parameters","id":"parameters-3","depth":3},{"value":"Returns","id":"returns-4","depth":3},{"value":"Example","id":"example-4","depth":3},{"value":"registerWebAuthnWithData","id":"registerwebauthnwithdata","depth":2},{"value":"Parameters","id":"parameters-4","depth":3},{"value":"Returns","id":"returns-5","depth":3},{"value":"Example","id":"example-5","depth":3},{"value":"authenticateWebAuthn","id":"authenticatewebauthn","depth":2},{"value":"Parameters","id":"parameters-5","depth":3},{"value":"Returns","id":"returns-6","depth":3},{"value":"Example","id":"example-6","depth":3},{"value":"authenticateWebAuthnWithData","id":"authenticatewebauthnwithdata","depth":2},{"value":"Parameters","id":"parameters-6","depth":3},{"value":"Returns","id":"returns-7","depth":3},{"value":"Example","id":"example-7","depth":3},{"value":"signWebAuthnTransaction","id":"signwebauthntransaction","depth":2},{"value":"Parameters","id":"parameters-7","depth":3},{"value":"Returns","id":"returns-8","depth":3},{"value":"Example","id":"example-8","depth":3},{"value":"signWebAuthnTransactionWithData","id":"signwebauthntransactionwithdata","depth":2},{"value":"Parameters","id":"parameters-8","depth":3},{"value":"Returns","id":"returns-9","depth":3},{"value":"Example","id":"example-9","depth":3},{"value":"approvalWebAuthn","id":"approvalwebauthn","depth":2},{"value":"Parameters","id":"parameters-9","depth":3},{"value":"Returns","id":"returns-10","depth":3},{"value":"Example","id":"example-10","depth":3},{"value":"approvalWebAuthnWithData","id":"approvalwebauthnwithdata","depth":2},{"value":"Parameters","id":"parameters-10","depth":3},{"value":"Returns","id":"returns-11","depth":3},{"value":"Example","id":"example-11","depth":3},{"value":"registerNativeBiometrics","id":"registernativebiometrics","depth":2},{"value":"Parameters","id":"parameters-11","depth":3},{"value":"Returns","id":"returns-12","depth":3},{"value":"Example","id":"example-12","depth":3},{"value":"authenticateNativeBiometrics","id":"authenticatenativebiometrics","depth":2},{"value":"Parameters","id":"parameters-12","depth":3},{"value":"Returns","id":"returns-13","depth":3},{"value":"Example","id":"example-13","depth":3},{"value":"approvalNativeBiometrics","id":"approvalnativebiometrics","depth":2},{"value":"Example","id":"example-14","depth":3},{"value":"unregisterNativeBiometrics","id":"unregisternativebiometrics","depth":2},{"value":"Parameters","id":"parameters-13","depth":3},{"value":"Returns","id":"returns-14","depth":3},{"value":"Example","id":"example-15","depth":3},{"value":"getNativeBiometricsStatus","id":"getnativebiometricsstatus","depth":2},{"value":"Returns","id":"returns-15","depth":3},{"value":"Example","id":"example-16","depth":3},{"value":"registerPinCode","id":"registerpincode","depth":2},{"value":"Parameters","id":"parameters-14","depth":3},{"value":"Returns","id":"returns-16","depth":3},{"value":"Example","id":"example-17","depth":3},{"value":"commitPinRegistration","id":"commitpinregistration","depth":2},{"value":"Parameters","id":"parameters-15","depth":3},{"value":"Returns","id":"returns-17","depth":3},{"value":"Example","id":"example-18","depth":3},{"value":"authenticatePinCode","id":"authenticatepincode","depth":2},{"value":"Parameters","id":"parameters-16","depth":3},{"value":"Returns","id":"returns-18","depth":3},{"value":"Example","id":"example-19","depth":3},{"value":"unregisterPinCode","id":"unregisterpincode","depth":2},{"value":"Parameters","id":"parameters-17","depth":3},{"value":"Returns","id":"returns-19","depth":3},{"value":"Example","id":"example-20","depth":3},{"value":"commitPinUnregistration","id":"commitpinunregistration","depth":2},{"value":"Parameters","id":"parameters-18","depth":3},{"value":"Returns","id":"returns-20","depth":3},{"value":"Example","id":"example-21","depth":3},{"value":"registerTOTP","id":"registertotp","depth":2},{"value":"Parameters","id":"parameters-19","depth":3},{"value":"Returns","id":"returns-21","depth":3},{"value":"Example","id":"example-22","depth":3},{"value":"generateTOTPCode","id":"generatetotpcode","depth":2},{"value":"Parameters","id":"parameters-20","depth":3},{"value":"Returns","id":"returns-22","depth":3},{"value":"Example","id":"example-23","depth":3},{"value":"generateTOTPCodeWithChallenge","id":"generatetotpcodewithchallenge","depth":2},{"value":"Parameters","id":"parameters-21","depth":3},{"value":"Returns","id":"returns-23","depth":3},{"value":"Example","id":"example-24","depth":3},{"value":"getDeviceInfo","id":"getdeviceinfo","depth":2},{"value":"Returns","id":"returns-24","depth":3},{"value":"Example","id":"example-25","depth":3},{"value":"signWithDeviceKey","id":"signwithdevicekey","depth":2},{"value":"Parameters","id":"parameters-22","depth":3},{"value":"Returns","id":"returns-25","depth":3},{"value":"Example","id":"example-26","depth":3},{"value":"isUserCanceled","id":"isusercanceled","depth":2},{"value":"Parameters","id":"parameters-23","depth":3},{"value":"Returns","id":"returns-26","depth":3},{"value":"Example","id":"example-27","depth":3}],"frontmatter":{"seo":{"title":"Functions"}},"lastModified":"2026-11-02T11:00:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-ref/cordova-ts-authentication/functions","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}