@digitalpersona/enrollment
Version:
DigitalPersona Enrollment API
1,514 lines • 106 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.2",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@digitalpersona/enrollment",
"docComment": "",
"name": "@digitalpersona/enrollment",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "(ContactlessCardEnroll:class)",
"docComment": "/**\n * Contactless card enrollment API.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "ContactlessCardEnroll"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Enroller"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ContactlessCardEnroll",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new contactless card enrollment API object.\n *\n * @param context - an {@link EnrollmentContext | enrollment context}.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(canEnroll:instance,0)",
"docComment": "/**\n * Reads a card enrollment availability.\n *\n * @returns a fulfilled promise when a card can be enrolled, a rejected promise otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canEnroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "canEnroll"
},
{
"kind": "Method",
"canonicalReference": "(enroll:instance,0)",
"docComment": "/**\n * Enrolls a card.\n *\n * @param cardData - a card enrollment data obtained using {@link CardsReader.getCardEnrollData}.\n *\n * @returns a promise to perform the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "cardData"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "cardData",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "enroll"
},
{
"kind": "Method",
"canonicalReference": "(unenroll:instance,0)",
"docComment": "/**\n * Deletes the card enrollment.\n *\n * @returns a promise to delete the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "unenroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "unenroll"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(EnrollmentContext:class)",
"docComment": "/**\n * Enrollment context.\n *\n * @remarks\n *\n * Pass the context object into token enrollment APIs. The single context may be shared.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "EnrollmentContext",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new instance of the `EnrollmentContext` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(\n "
},
{
"kind": "Reference",
"text": "enrollService"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "IEnrollService"
},
{
"kind": "Content",
"text": ", \n "
},
{
"kind": "Reference",
"text": "user"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "JSONWebToken"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "User"
},
{
"kind": "Content",
"text": ", \n "
},
{
"kind": "Reference",
"text": "securityOfficer"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONWebToken"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "enrollService",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "user",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 10
}
},
{
"parameterName": "securityOfficer",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
}
}
]
},
{
"kind": "Property",
"canonicalReference": "(enrollService:instance)",
"docComment": "/**\n * DigitalPersona Enrollment web service client\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "enrollService"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "IEnrollService"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "enrollService",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(getJWT:instance,0)",
"docComment": "/**\n * Returns user identity in a form of authentication token.\n *\n * @remarks\n *\n * The user must be authenticated.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getJWT"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "JSONWebToken"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getJWT"
},
{
"kind": "Method",
"canonicalReference": "(getUser:instance,0)",
"docComment": "/**\n * Returns user identity in a form of a username.\n *\n * @remarks\n *\n * The user may be authenticated or not. If authenticated, the username will be produced from the authentication token claims.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getUser"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "User"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getUser"
},
{
"kind": "Method",
"canonicalReference": "(isAuthenticated:instance,0)",
"docComment": "/**\n * Check is the user has an authentication token, or just a user name.\n *\n * @returns `true` if user identity represented by an authenticatication token, `false` otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "isAuthenticated"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "isAuthenticated"
},
{
"kind": "Property",
"canonicalReference": "(securityOfficer:instance)",
"docComment": "/**\n * An optional JSON Web Token of a security officer performing an attended enrollment. If not provided, the API should try to use a user's own token instead for a self-enrollment. In this case the user must be allowed to do self-enrollment.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "securityOfficer"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "JSONWebToken"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "securityOfficer",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(user:instance)",
"docComment": "/**\n * A JSON Web Token or a username of a user whose credentials are to be enrolled.\n *\n * @remarks\n *\n * Only DigitalPersona users (formerly \"Altus User\") can be enrolled without authentication, i.e. using only a user name. Other users must be authenticated, i.e. have a JSON Web Token.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "user"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "JSONWebToken"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "User"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "user",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 5
},
"isStatic": false
}
],
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(FaceEnroll:class)",
"docComment": "/**\n * Face enrollment API.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "FaceEnroll"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Enroller"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FaceEnroll",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new face enrollment API object.\n *\n * @param context - an {@link EnrollmentContext | enrollment context}.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(canEnroll:instance,0)",
"docComment": "/**\n * Reads a face enrollment availability.\n *\n * @returns a fulfilled promise when a face can be enrolled, a rejected promise otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canEnroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "canEnroll"
},
{
"kind": "Method",
"canonicalReference": "(enroll:instance,0)",
"docComment": "/**\n * Enrolls a face.\n *\n * @param samples - a collection of face images.\n *\n * @returns a promise to perform the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enroll"
},
{
"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": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "samples",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
}
],
"name": "enroll"
},
{
"kind": "Method",
"canonicalReference": "(unenroll:instance,0)",
"docComment": "/**\n * Deletes the face enrollment.\n *\n * @returns a promise to delete the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "unenroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "unenroll"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(FingerprintsEnroll:class)",
"docComment": "/**\n * Fingerprint enrollment API.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "FingerprintsEnroll"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Enroller"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "FingerprintsEnroll",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new fingerprint enrollment API object.\n *\n * @param context - an {@link EnrollmentContext | enrollment context}.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(canEnroll:instance,0)",
"docComment": "/**\n * Reads a fingerprint enrollment availability.\n *\n * @returns a fulfilled promise when fingerprints can be enrolled, a rejected promise otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canEnroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "canEnroll"
},
{
"kind": "Method",
"canonicalReference": "(enroll:instance,0)",
"docComment": "/**\n * Enrolls a fingerprint.\n *\n * @param position - a position of a finger to enroll\n *\n * @param samples - a collection of fingerprint scans.\n *\n * @returns a promise to perform the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "position"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "FingerPosition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Finger"
},
{
"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": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "position",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 7
}
},
{
"parameterName": "samples",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
}
}
],
"name": "enroll"
},
{
"kind": "Method",
"canonicalReference": "(getEnrolledFingers:instance,0)",
"docComment": "/**\n * Reads a fingerprint enrollment status.\n *\n * @returns a promise to return fingerprint enrollment data. The data is a collection of enrolled fingers.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getEnrolledFingers"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Fingers"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "getEnrolledFingers"
},
{
"kind": "Method",
"canonicalReference": "(unenroll:instance,0)",
"docComment": "/**\n * Deletes the fingerprint enrollment.\n *\n * @param position - a position(s) of a finger(s) to delete. If not defined, all enrolled fingerprintss will be deleted.\n *\n * @returns a promise to delete the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "unenroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "position"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "FingerPosition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Finger"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Array"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FingerPosition"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "Finger"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 15,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "position",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 14
}
}
],
"name": "unenroll"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(PasswordEnroll:class)",
"docComment": "/**\n * Password enrollment API.\n *\n * @remarks\n *\n * As a primary credential, user's password cannot be unenroled, it can only be changed, reset or randomized.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "PasswordEnroll"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Enroller"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PasswordEnroll",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new password enrollment API object.\n *\n * @param context - an {@link EnrollmentContext | enrollment context}.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(canEnroll:instance,0)",
"docComment": "/**\n * Reads a password change availability.\n *\n * @returns a fulfilled promise when a password can be changed, a rejected promise otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canEnroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "canEnroll"
},
{
"kind": "Method",
"canonicalReference": "(enroll:instance,0)",
"docComment": "/**\n * Changes a password.\n *\n * @param newPassword - a new password.\n *\n * @param oldPassword - a password to replace. Must match the existing password.\n *\n * @returns a promise to perform the password change or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "newPassword"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "oldPassword"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "newPassword",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "oldPassword",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "enroll"
},
{
"kind": "Method",
"canonicalReference": "(randomize:instance,0)",
"docComment": "/**\n * Creates a new strong password with good complexity properties.\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 * @returns a promise to return a randomized password.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "randomize"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "randomize"
},
{
"kind": "Method",
"canonicalReference": "(reset:instance,0)",
"docComment": "/**\n * Resets a 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 newPassword - a new password which will replace any existing password.\n *\n * @returns a promise to perform the password reset or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "reset"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "newPassword"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "newPassword",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "reset"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "(PinEnroll:class)",
"docComment": "/**\n * Personal Identification Number (PIN) enrollment API.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "PinEnroll"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Enroller"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "PinEnroll",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new PIN enrollment API object.\n *\n * @param context - an {@link EnrollmentContext | enrollment context}.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "EnrollmentContext"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(canEnroll:instance,0)",
"docComment": "/**\n * Reads a PIN enrollment availability.\n *\n * @returns a fulfilled promise when a PIN can be enrolled, a rejected promise otherwise.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "canEnroll"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "canEnroll"
},
{
"kind": "Method",
"canonicalReference": "(enroll:instance,0)",
"docComment": "/**\n * Enrolls a PIN.\n *\n * @param pin - a Personal Identification Number (PIN).\n *\n * @returns a promise to perform the enrollment or reject in case of an error.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "enroll"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "pin"
},
{
"kind": "Content",
"text": ": "
},
{