{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.2.2", "schemaVersion": 1001, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@digitalpersona/authentication", "docComment": "", "name": "@digitalpersona/authentication", "members": [ { "kind": "EntryPoint", "canonicalReference": "", "name": "", "members": [ { "kind": "Class", "canonicalReference": "(ContactlessCardAuth:class)", "docComment": "/**\n * Contactless card authentication API. Contactless cards support both authentication and identification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ContactlessCardAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ContactlessCardAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new contactless authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a contactless card.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param cardData - card authentication data received from the card using a `CardsReader.getCardAuthData`.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a contactless card was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "cardData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "cardData", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(identify:instance,0)", "docComment": "/**\n * Identifies the user with a contactless card.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param cardData - card authentication data received from the card using a `CardsReader.getCardAuthData`.\n *\n * @returns a promise to return a JSON Web Token containing a subject identity claims (`sub`, `group`, etc) and a claim (`crd`) showing the fact a contactless card was used. Will reject if identification fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "cardData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "cardData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "identify" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(EmailOtpAuth:class)", "docComment": "/**\n * A one-time password authentication API based on a electronic mail (Email OTP). Email OTP supports only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "EmailOtpAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "EmailOtpAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new Email OTP authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a challenge sent to the user's registered e-mail address.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param code - a code the user received via e-mail challenge.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a OTP was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(sendChallenge:instance,0)", "docComment": "/**\n * Sends an e-mail challenge with a OTP code to the user's registered mobile device.\n *\n * @remarks\n *\n * The user has to have an email registered in their LADP user record in ActiveDirectory or LDS. The server will look for a first entry in a `mail` LDAP atribute of the user record.\n *\n * @param user - a name of the user\n *\n * @returns a promise to send the challenge code to the registered e-mail address. Will reject if user has no email or in case of any other error.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "sendChallenge" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "sendChallenge" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(FaceAuth:class)", "docComment": "/**\n * Face authentication API. Face credential supports authentication. Identification is currently not supported by the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "FaceAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FaceAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new face authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using their face images.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param samples - a collection of biometric samples with face images.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a face was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "samples" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "samples", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 12 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(identify:instance,0)", "docComment": "/**\n * Currently face identification is not supported by the server.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "samples" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "samples", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "identify" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(Finger:class)", "docComment": "/**\n * A finger enrollment data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Finger", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `Finger` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "position" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(fromJson:static,0)", "docComment": "/**\n * Creates a finger enrollment data object from a plain JSON object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromJson" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "json" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "json", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "fromJson" }, { "kind": "Property", "canonicalReference": "(position:instance)", "docComment": "/**\n * A finger position.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "position" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(FingerPosition:enum)", "docComment": "/**\n * Finger positions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "FingerPosition" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FingerPosition", "members": [ { "kind": "EnumMember", "canonicalReference": "LeftIndex", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftIndex" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "7" } ], "releaseTag": "Public", "name": "LeftIndex", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftLittle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftLittle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "10" } ], "releaseTag": "Public", "name": "LeftLittle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftMiddle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftMiddle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "LeftMiddle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftRing", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftRing" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "9" } ], "releaseTag": "Public", "name": "LeftRing", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LeftThumb", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LeftThumb" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "6" } ], "releaseTag": "Public", "name": "LeftThumb", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightIndex", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightIndex" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "RightIndex", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightLittle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightLittle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "5" } ], "releaseTag": "Public", "name": "RightLittle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightMiddle", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightMiddle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "RightMiddle", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightRing", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightRing" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "RightRing", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RightThumb", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RightThumb" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "RightThumb", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Unknown", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Unknown" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Unknown", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(FingerprintsAuth:class)", "docComment": "/**\n * Fingerprint authentication API. Fingerprints support both authentication and identification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "FingerprintsAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "FingerprintsAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new fingerprint authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using their fingerprint samples.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param samples - a collection of biometric samples with fingerprint scans.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a fingerprint was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "samples" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "samples", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 12 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(getEnrolledFingers:instance,0)", "docComment": "/**\n * Reads a list of fingers currently enrolled by the user.\n *\n * @param user - a user name\n *\n * @returns a promise to return a list of enrolled fingers. If no fingers are enrolled, an emty list will be returned. May reject if the user is unknown or in case of an error.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getEnrolledFingers" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Fingers" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "getEnrolledFingers" }, { "kind": "Method", "canonicalReference": "(identify:instance,0)", "docComment": "/**\n * Identifies the user with their fingerprints.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param samples - a collection of biometric samples with fingerprint scans.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a fingerprint was used. Will reject if identification fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "samples" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BioSample" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "samples", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "identify" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(PasswordAuth:class)", "docComment": "/**\n * Password authentication API. Passwords support only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "PasswordAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PasswordAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new password authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using user's password.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param password - a user's password.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a password was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "password" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(randomize:instance,0)", "docComment": "/**\n * Creates a randomized user's password.\n *\n * @remarks\n *\n * DigitalPersona AD Server supports password randomization only for ActiveDirectory users. DigitalPersona LDS Server supports password randomization only for DigitalPersona users (formerly \"Altus Users\").\n *\n * @param user - a user's name.\n *\n * @param token - a JSON Web Token of a person initiating a password randomization. This person must have a privilege to randomize user passwords.\n *\n * @returns a promise to return a new randomized password.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "randomize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "token" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "token", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "randomize" }, { "kind": "Method", "canonicalReference": "(reset:instance,0)", "docComment": "/**\n * Resets user's password.\n *\n * @remarks\n *\n * DigitalPersona AD Server supports password randomization only for ActiveDirectory users. DigitalPersona LDS Server supports password randomization only for DigitalPersona users (formerly \"Altus Users\").\n *\n * @param user - a user's name.\n *\n * @param newPassword - a new password to replace the old password.\n *\n * @param token - a JSON Web Token of a person initiating a password reset. This person must have a privilege to set users' passwords.\n *\n * @returns a promise to reset user's password.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "reset" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "newPassword" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "token" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "newPassword", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "token", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "reset" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(PinAuth:class)", "docComment": "/**\n * Personal Identification Number (PIN) authentication API. PIN support only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "PinAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PinAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new PIN authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using user's PIN code.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param pin - a user's PIN.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a PIN was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "pin" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "pin", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(ProximityCardAuth:class)", "docComment": "/**\n * Proximity card authentication API. Proximity cards support both authentication and identification.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ProximityCardAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ProximityCardAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new proximity authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a proximimty card.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param cardData - card authentication data received from the card using a `CardsReader.getCardAuthData`.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a proximity card was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "cardData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "cardData", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(identify:instance,0)", "docComment": "/**\n * Identifies the user with a proximity card.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param cardData - card authentication data received from the card using a `CardsReader.getCardAuthData`.\n *\n * @returns a promise to return a JSON Web Token containing a subject identity claims (`sub`, `group`, etc) and a claim (`crd`) showing the fact a proximity card was used. Will reject if identification fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "cardData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "cardData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "identify" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(PushOtpAuth:class)", "docComment": "/**\n * A one-time password authentication API based on Push Notifications (Push OTP). Push OTP supports only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "PushOtpAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PushOtpAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new Push OTP authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a Push Notification on the user's registered mobile device.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * The user must have a mobile device with a DigitalPersona authenticator app installed and registered in the DigitalPersona server. The user will receive a Push Notification on their mobile device via the app and must accept the notification to proceed. The promise returned by the method will be resolved when the user accepts the notification, otherwise it will reject with a timeout error.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a OTP was used. To resolve the promise, the user must accept a Push Notification sent to their mobile device. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } } ], "name": "authenticate" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(SecurityQuestionsAuth:class)", "docComment": "/**\n * Security Questions authentication API. Security Questions support only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "SecurityQuestionsAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SecurityQuestionsAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new Security Questions authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using user's answers to security questions.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param answers - user's answers to security questions.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a Security Questions were used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "answers" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Answers" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "answers", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(getEnrolledQuestions:instance,0)", "docComment": "/**\n * Reads a list of security questions enrolled by the user.\n *\n * @param user - a user's name.\n *\n * @returns a promise to return a list of enrolled questions.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getEnrolledQuestions" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Questions" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "getEnrolledQuestions" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(SmartCardAuth:class)", "docComment": "/**\n * Smart card authentication API. Smartcards supports only authentication with PIN. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "SmartCardAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SmartCardAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new smartcard authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a smartcard.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param cardData - card authentication data received from the card using a PIN.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a smartcard was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "cardData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "cardData", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(SmsOtpAuth:class)", "docComment": "/**\n * A one-time password authentication API based on a Short Message Service (SMS OTP). SMS OTP supports only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "SmsOtpAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SmsOtpAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new SMS OTP authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a challenge sent to the user's registered mobile device via SMS.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * The user must have a mobile device with a phone number registered in the DigitalPersona server. The user will receive an SMS on their mobile device and must type the code sent with the message.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param code - a code the device user received via SMS challenge.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a OTP was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(sendChallenge:instance,0)", "docComment": "/**\n * Sends an SMS challenge with a OTP code to the user's registered mobile device.\n *\n * @param user - a name of the user\n *\n * @returns a promise to send the challenge code.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "sendChallenge" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "sendChallenge" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(TimeOtpAuth:class)", "docComment": "/**\n * Time-based one-time password (TOTP) authentication API. TOTP supports only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "TimeOtpAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TimeOtpAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new TOTP authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using user's TOTP code.\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @param code - a TOTP code.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a OTP was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(getUnlockCode:instance,0)", "docComment": "/**\n * Creates a code allowing to unlock a hardware TOTP device when it locks after a number of unsuccessful PIN entries.\n *\n * @param userOrSerialNumber - a username or a locked device serial number.\n *\n * @param challenge - a challenge code provided by the locked device user.\n *\n * @param token - an optional JSON Web Token of the locked device user.\n *\n * @returns a promise to return an unlock code that the locked device user must type in.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getUnlockCode" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "userOrSerialNumber" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "challenge" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "token" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 15, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "userOrSerialNumber", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } }, { "parameterName": "challenge", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } }, { "parameterName": "token", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ], "name": "getUnlockCode" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(U2FAuth:class)", "docComment": "/**\n * Universal Second Factor (U2F) authentication API. U2F support only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "U2FAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "U2FAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new U2F authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates the user using a user's registered U2F token (FIDO token).\n *\n * @remarks\n *\n * If the `identity` parameter is a user name, a new token will be created. If the `identity` parameter is a JSON Web Token, an updated token will be returned.\n *\n * The user must have a U2F (FIDO) token enrolled in the DigitalPersona server. The user should insert the token and activate it using a touch or pressing a device button. The promise returned by the method will be resolved after the user activates the token, otherwise it will reject with a timeout error.\n *\n * @param identity - a {@link User | username} or a JSON Web Token.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a U2F was used. To resolve the promise, the user must touch the U2F token when prompted. Will reject if authentication fails or times out.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 8, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } } ], "name": "authenticate" }, { "kind": "Method", "canonicalReference": "(getAppId:instance,0)", "docComment": "/**\n * Reads U2F AppID endpoint URL.\n *\n * @returns a promise to return a U2F AppID endpoint URL.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getAppId" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "getAppId" }, { "kind": "Method", "canonicalReference": "(isSupported:static,0)", "docComment": "/**\n * Checks is the U2F supported on this platform.\n *\n * @remarks\n *\n * To support U2F the user agent must have required API, the web site must use HTTPS, and the DigitalPersona Web Components server must have properly configured U2F AppId for the site.\n *\n * @returns a promise to return `true` is the platform supports U2F or `false` otherwise.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "isSupported" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "isSupported" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(WindowsAuth:class)", "docComment": "/**\n * Integrated Windows authentication API. IWA support only authentication. Identification is not supported.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "WindowsAuth" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Authenticator" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "WindowsAuth", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new integrated Windows authentication API object.\n *\n * @param authService - an {@link AuthService | authentication service client} connected to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "authService" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "client" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IAuthenticationClient" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authService", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "client", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Method", "canonicalReference": "(authenticate:instance,0)", "docComment": "/**\n * Authenticates using a currently logged Windows user.\n *\n * @returns a promise to return a JSON Web Token containing a claim (`crd`) showing the fact a currently logged Window account was used. Will reject if authentication fails.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "authenticate" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "JSONWebToken" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "authenticate" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "Fingers", "docComment": "/**\n * A collection of finger enrollment data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Fingers" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "Finger" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Fingers", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } } ] } ] }