{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.2.2", "schemaVersion": 1001, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@digitalpersona/services", "docComment": "", "name": "@digitalpersona/services", "members": [ { "kind": "EntryPoint", "canonicalReference": "", "name": "", "members": [ { "kind": "Class", "canonicalReference": "(AdminService:class)", "docComment": "/**\n * DigitalPersona WebAuth (DPWebAuth) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "AdminService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "IAdminService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AdminService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(AdminDeleteUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "AdminDeleteUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentials" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "[]" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credentials", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 14 } } ], "name": "AdminDeleteUserCredentials" }, { "kind": "Method", "canonicalReference": "(ExecuteSearch:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ExecuteSearch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "query" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "SearchQuery" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[][]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ExecuteSearch" }, { "kind": "Method", "canonicalReference": "(GetLicenseInfo:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetLicenseInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "LicenseType" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "LicenseInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetLicenseInfo" }, { "kind": "Method", "canonicalReference": "(GetServerSettings:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetServerSettings" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "settings", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetServerSettings" }, { "kind": "Method", "canonicalReference": "(GetUserInfo:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": "UserInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetUserInfo" }, { "kind": "Method", "canonicalReference": "(GetUserRecoveryPassword:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserRecoveryPassword" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "encryptedPwd" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "encryptedPwd", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetUserRecoveryPassword" }, { "kind": "Method", "canonicalReference": "(PSKCImport:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "PSKCImport" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PSKCData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PSKCFileName" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "password" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "sharedKey" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PSKCOutput" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 22, "endIndex": 26 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "PSKCData", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "PSKCFileName", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } }, { "parameterName": "sharedKey", "parameterTypeTokenRange": { "startIndex": 20, "endIndex": 21 } } ], "name": "PSKCImport" }, { "kind": "Method", "canonicalReference": "(SetServerSettings:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SetServerSettings" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ServerSettingType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[]" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "settings", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 14 } } ], "name": "SetServerSettings" }, { "kind": "Method", "canonicalReference": "(SetUserAccountControl:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SetUserAccountControl" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "control" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "UACFlags" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "control", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "SetUserAccountControl" }, { "kind": "Method", "canonicalReference": "(UnlockUserAccount:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "UnlockUserAccount" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "UnlockUserAccount" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "(Attribute:interface)", "docComment": "/**\n * A named attribute with a variant data value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Attribute", "members": [ { "kind": "PropertySignature", "canonicalReference": "data", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "VarData" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(AttributeAction:enum)", "docComment": "/**\n * Enumerates supported actions that can be performed on user's attributes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "AttributeAction" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AttributeAction", "members": [ { "kind": "EnumMember", "canonicalReference": "Append", "docComment": "/**\n * Append a value to the existing multi-value attribute.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Append" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "Append", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Clear", "docComment": "/**\n * Clear an attribute's value.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Clear" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Clear", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Delete", "docComment": "/**\n * Delete an attribute.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Delete" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "Delete", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Update", "docComment": "/**\n * Update an attribute's value.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Update" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Update", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(AuthenticationData:class)", "docComment": "/**\n * Client-side authentication data used by the {@link IAuthenticationClient} during authentication handshake.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "AuthenticationData" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AuthenticationData", "members": [ { "kind": "Property", "canonicalReference": "(data:instance)", "docComment": "/**\n * Client's authentication data to pass to the server.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "data", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(handle:instance)", "docComment": "/**\n * An authentication handle. The client must create the handle on {@link IAuthenticationClient.init}, and destroy on {@link IAuthenticationClient.done}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "handle" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "handle", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(AuthenticationStatus:enum)", "docComment": "/**\n * Enumerated possible authentication statuses.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "AuthenticationStatus" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AuthenticationStatus", "members": [ { "kind": "EnumMember", "canonicalReference": "Completed", "docComment": "/**\n * Authentication is complete.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Completed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Completed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Continue", "docComment": "/**\n * Authentication is in progress.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Continue" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Continue", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Error", "docComment": "/**\n * Authentication failed.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Error", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(AuthService:class)", "docComment": "/**\n * DigitalPersona WebAuth (DPWebAuth) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "AuthService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AuthService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(Authenticate:instance,0)", "docComment": "/**\n * @inheritdoc\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": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "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": "credential", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "Authenticate" }, { "kind": "Method", "canonicalReference": "(ContinueAuthentication:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ContinueAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "authId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "authData" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ExtendedAuthResult" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "authId", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "authData", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ContinueAuthentication" }, { "kind": "Method", "canonicalReference": "(CreateAuthentication:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "CreateAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "CreateAuthentication" }, { "kind": "Method", "canonicalReference": "(CustomAction:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "CustomAction" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "actionId" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "actionId", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "CustomAction" }, { "kind": "Method", "canonicalReference": "(DestroyAuthentication:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DestroyAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "authId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "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": "authId", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "DestroyAuthentication" }, { "kind": "Method", "canonicalReference": "(GetEnrollmentData:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetEnrollmentData" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetEnrollmentData" }, { "kind": "Method", "canonicalReference": "(GetUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserCredentials" }, { "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": "CredentialId" }, { "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": "GetUserCredentials" }, { "kind": "Method", "canonicalReference": "(Identify:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "Identify" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Class", "canonicalReference": "(ClaimRequest:class)", "docComment": "/**\n * A request for a identity claim. The service will search an {@link ClaimRequest.attr | attribute} in a {@link ClaimRequest.database} and return the attribute value as a claim {@link ClaimRequest.name | name} in a token.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ClaimRequest" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ClaimRequest", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a claim request.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(\n " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ClaimNames" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "db" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DatabaseType" }, { "kind": "Content", "text": ", \n " }, { "kind": "Reference", "text": "attr" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AttributeName" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "db", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "attr", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ] }, { "kind": "Property", "canonicalReference": "(attr:instance)", "docComment": "/**\n * An attribute name to search.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "attr" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AttributeName" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "attr", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(db:instance)", "docComment": "/**\n * A database to search for an attribute.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "db" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DatabaseType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "db", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "/**\n * A name of a claim to return.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ClaimNames" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(ClaimsService:class)", "docComment": "/**\n * DigitalPersona Web Claims (DPWebClaims) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ClaimsService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "IClaimsService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ClaimsService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(GetClaims:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetClaims" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ClaimRequest" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 10 } } ], "name": "GetClaims" }, { "kind": "Method", "canonicalReference": "(GetConfiguredClaims:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetConfiguredClaims" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetConfiguredClaims" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Class", "canonicalReference": "(ContextualInfo:class)", "docComment": "/**\n * A context of an authentication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ContextualInfo", "members": [ { "kind": "Property", "canonicalReference": "(altusInstalled:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "altusInstalled" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "altusInstalled", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(behavior:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "behavior" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "behavior", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(computer:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "computer" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "computer", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(device:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "device" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "device", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(domain:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "domain" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "domain", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(insideFirewall:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "insideFirewall" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "insideFirewall", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(ip:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ip" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ip", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(remoteSession:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "remoteSession" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "remoteSession", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(user:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "user", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(DatabaseType:enum)", "docComment": "/**\n * Enumerates supported identity databases.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "DatabaseType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "DatabaseType", "members": [ { "kind": "EnumMember", "canonicalReference": "AD", "docComment": "/**\n * ActiveDirectory (AD)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "AD" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"AD\"" } ], "releaseTag": "Public", "name": "AD", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LDS", "docComment": "/**\n * Lightweight Directory Service (LDS)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "LDS" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"ADLDS\"" } ], "releaseTag": "Public", "name": "LDS", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(EnrollService:class)", "docComment": "/**\n * DigitalPersona Web Enroll (DPWebEnroll) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "EnrollService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "IEnrollService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "EnrollService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(CreateUser:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "CreateUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "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": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "CreateUser" }, { "kind": "Method", "canonicalReference": "(CustomAction:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "CustomAction" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "actionId" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "actionId", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "CustomAction" }, { "kind": "Method", "canonicalReference": "(DeleteAltusUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DeleteAltusUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "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": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "DeleteAltusUserCredentials" }, { "kind": "Method", "canonicalReference": "(DeleteUser:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DeleteUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DeleteUser" }, { "kind": "Method", "canonicalReference": "(DeleteUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DeleteUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "owner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "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": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "owner", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "DeleteUserCredentials" }, { "kind": "Method", "canonicalReference": "(EnrollAltusUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "EnrollAltusUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "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": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "EnrollAltusUserCredentials" }, { "kind": "Method", "canonicalReference": "(EnrollUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "EnrollUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "owner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "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": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "owner", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "EnrollUserCredentials" }, { "kind": "Method", "canonicalReference": "(GetEnrollmentData:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetEnrollmentData" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetEnrollmentData" }, { "kind": "Method", "canonicalReference": "(GetUserAttribute:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserAttribute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "attributeName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "attributeName", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetUserAttribute" }, { "kind": "Method", "canonicalReference": "(GetUserCredentials:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserCredentials" }, { "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": "CredentialId" }, { "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": "GetUserCredentials" }, { "kind": "Method", "canonicalReference": "(IsEnrollmentAllowed:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "IsEnrollmentAllowed" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "secOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "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": "secOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "IsEnrollmentAllowed" }, { "kind": "Method", "canonicalReference": "(PutUserAttribute:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "PutUserAttribute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "attribute" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AttributeAction" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 18, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "attribute", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "PutUserAttribute" }, { "kind": "Method", "canonicalReference": "(UnlockUser:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "UnlockUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "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": "credential", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "UnlockUser" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "(ExtendedAuthResult:interface)", "docComment": "/**\n * Result of authentication handshake containing {@link AuthenticationsStatus} and optional authentication data payload.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ExtendedAuthResult" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ExtendedAuthResult", "members": [ { "kind": "PropertySignature", "canonicalReference": "authData", "docComment": "/**\n * Authentication payload data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "authData" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "authData", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "status", "docComment": "/**\n * An authentication status.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "status" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationStatus" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "status", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(IAdminService:interface)", "docComment": "/**\n * DigitalPersona Web Administration (DPWebAdmin) service interface.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IAdminService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IAdminService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(AdminDeleteUserCredentials:0)", "docComment": "/**\n * Deletes specified user credentias without the user's presence.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to delete user credentials. The owner of the token must have permissions to reset user credentials.\n *\n * @param user - a user whose credentials will be deleted.\n *\n * @param credentials - a list of credentials ID to delete. NOTE: currently the `data` part of credentials is ignored.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "AdminDeleteUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentials" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 15, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credentials", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 14 } } ], "name": "AdminDeleteUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(ExecuteSearch:0)", "docComment": "/**\n * Executes a search on the DPCA Server database and returns the result of search operation. NOTE: The result of search operation is limited to 100 records.\n *\n * @param - ticket\n *\n * @param - query\n *\n * @returns a promise to return a list of the rows, where each row is a list or requested object attributes. NOTE: The maximum number of rows is limited to 100, the rest of the result is truncated.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ExecuteSearch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "query" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "SearchQuery" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[][]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "query", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ExecuteSearch" }, { "kind": "MethodSignature", "canonicalReference": "(GetLicenseInfo:0)", "docComment": "/**\n * Query licensing information from the DPCA Server.\n *\n * @param licenseType - a type of a license to query\n *\n * @returns a license information\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetLicenseInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "licenseType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "LicenseType" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "LicenseInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "licenseType", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetLicenseInfo" }, { "kind": "MethodSignature", "canonicalReference": "(GetServerSettings:0)", "docComment": "/**\n * Queries a list of settings from DPCA Server.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to query server settings. Some settings may be queried anonymously.\n *\n * @param user - a user whom settings will be queried. User name will direct to the particular DPCA Server where information about this user saved. This parameter is optional and can be set to null. If set to null, we direct call to DPCA Server where information about ticket owner is saved. If both user and ticket set to null, we direct call to DPCA Server where Altus Confirm is installed.\n *\n * @param settings - a list of settings to query.\n *\n * @returns a promise to return a list of the settings requested\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetServerSettings" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "settings", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetServerSettings" }, { "kind": "MethodSignature", "canonicalReference": "(GetUserInfo:0)", "docComment": "/**\n * Queries an information about a specific user.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to request user information. The owner of the token must have permissions to query user information.\n *\n * @param user - a user whose information is to be requested.\n *\n * @returns - an information about the user.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": "UserInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetUserInfo" }, { "kind": "MethodSignature", "canonicalReference": "(GetUserRecoveryPassword:0)", "docComment": "/**\n * Requests a user recovery password.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to get Recover Password from DPCA Server. The owner of the token must have permissions to get a Recovery Password.\n *\n * @param user - a user who needs a recovery password\n *\n * @param encryptedPwd - a Recovery Password encrypted by the user Recovery Key. This encrypted password is provided by our Cred Provider during Windows Logon recovery procedure.\n *\n * @returns a promise to return a recovery password.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetUserRecoveryPassword" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "encryptedPwd" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "encryptedPwd", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetUserRecoveryPassword" }, { "kind": "MethodSignature", "canonicalReference": "(PSKCImport:0)", "docComment": "/**\n * Imports PSKC data to DPCA database.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to import PSKC data to DPCA database. The owner of the token must have permissions to import the data.\n *\n * @param PSKCData - a content of PSKC file provided by OTP vendor in Base64Url encoded format\n *\n * @param PSKCFileName - a name of PSKC file provided by OTP vendor. This name is required for audit purposes only.\n *\n * @param password - a password to protect PSKC data. This parameter is optional and will required only if Encryption Based on Passphrase-Based Keys is used for data protection in PSKC (see topic 6.2 of RFC6030, https://tools.ietf.org/html/rfc6030 for details)\n *\n * @param sharedKey - an encoded value of Pre-Shared key for PSKC secrets. The format of the encoding is manufacturer depended and unknown. It is server's responsibility to find out a proper encoding format and decode the key. This parameter is optional and it is required only if Encryption Based on Pre-Shared Keys is used for data protection in PSKC (see topic 6.1 of RFC6030, https://tools.ietf.org/html/rfc6030 for details)\n *\n * @returns a promise to return a list of objects in DPPSKCOutput format. It gives us information about result of importing operation for every OTP token inside PSKC file.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "PSKCImport" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PSKCData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PSKCFileName" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "password" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "sharedKey" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | null" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PSKCOutput" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 22, "endIndex": 26 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "PSKCData", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "PSKCFileName", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } }, { "parameterName": "sharedKey", "parameterTypeTokenRange": { "startIndex": 20, "endIndex": 21 } } ], "name": "PSKCImport" }, { "kind": "MethodSignature", "canonicalReference": "(SetServerSettings:0)", "docComment": "/**\n * Modifies a list of settings on the DPCA Server.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to modify server settings. The ticket owner has to have permissions to administer the server.\n *\n * @param type - a type of the settings\n *\n * @param settings - a collection of settings to set\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SetServerSettings" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ServerSettingType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 15, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "settings", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 14 } } ], "name": "SetServerSettings" }, { "kind": "MethodSignature", "canonicalReference": "(SetUserAccountControl:0)", "docComment": "/**\n * Modifies User Account Control bits for the specified user.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to modify UAC bits. The owner of the token must have permissions to set UAC bits.\n *\n * @param user - the user whose UAC bits are to be modified\n *\n * @param control - Account Control bits needs to be set. NOTE: The control bits provided will override any settings previously set for this particular user so we would recommend to call GetUserInfo or GetUserAttributeto find out what bits were set before the operation.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "SetUserAccountControl" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "control" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "UACFlags" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "control", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "SetUserAccountControl" }, { "kind": "MethodSignature", "canonicalReference": "(UnlockUserAccount:0)", "docComment": "/**\n * Unlocks previously locked user account.\n *\n * @param ticket - a ticket with a JSON Web Token of the user who would like to unlcok the user account. The owner of the token must have permissions to unlock user accounts.\n *\n * @param user - the user whose account is to be unlocked.\n *\n * @returns a promise to unlock the user account.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "UnlockUserAccount" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "UnlockUserAccount" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IAuthenticationClient:interface)", "docComment": "/**\n * Set of methods to support an authentication handshake protocol on a client side.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IAuthenticationClient" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IAuthenticationClient", "members": [ { "kind": "MethodSignature", "canonicalReference": "(continue:0)", "docComment": "/**\n * Continues the handshake. This method may be called several times until the {@link IAuthenticationClient.done} is called.\n *\n * @param handle - an authentication handle\n *\n * @param data - a server portion of the authentication handshake\n *\n * @returns a promise to return a client portion of authentication handshake data (Base64url-encoded).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "continue" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "handle" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "handle", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "continue" }, { "kind": "MethodSignature", "canonicalReference": "(init:0)", "docComment": "/**\n * Initiates an authentication handshake.\n *\n * @returns a promise to return an {@link AuthenticationData} when ready to continue.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "init" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AuthenticationData" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "init" }, { "kind": "MethodSignature", "canonicalReference": "(term:0)", "docComment": "/**\n * Finalizes the authentication handshake.\n *\n * @param handle - an authentication handle to close.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "term" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "handle" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "handle", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "term" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IAuthService:interface)", "docComment": "/**\n * DigitalPersona Web Authentication (DPWebAuth) service interface.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IAuthService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IAuthService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(Authenticate:0)", "docComment": "", "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": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 12, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 7 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "name": "Authenticate" }, { "kind": "MethodSignature", "canonicalReference": "(ContinueAuthentication:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ContinueAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "auth" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ExtendedAuthResult" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "auth", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ContinueAuthentication" }, { "kind": "MethodSignature", "canonicalReference": "(CreateAuthentication:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "CreateAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "identity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": " | null" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "CreateAuthentication" }, { "kind": "MethodSignature", "canonicalReference": "(CustomAction:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "CustomAction" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "actionId" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "actionId", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "CustomAction" }, { "kind": "MethodSignature", "canonicalReference": "(DestroyAuthentication:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DestroyAuthentication" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "auth" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "auth", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "DestroyAuthentication" }, { "kind": "MethodSignature", "canonicalReference": "(GetEnrollmentData:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetEnrollmentData" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetEnrollmentData" }, { "kind": "MethodSignature", "canonicalReference": "(GetUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetUserCredentials" }, { "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": "CredentialId" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(Identify:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Identify" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "Identify" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IClaimsService:interface)", "docComment": "/**\n * DigitalPersona Web Claims (DPWebClaims) service interface.\n *\n * This service allows to request additional claims to be added to the JSON Web Token issued by the AuthService.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IClaimsService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IClaimsService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(GetClaims:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetClaims" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ClaimRequest" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 10 } } ], "name": "GetClaims" }, { "kind": "MethodSignature", "canonicalReference": "(GetConfiguredClaims:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetConfiguredClaims" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetConfiguredClaims" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IEnrollService:interface)", "docComment": "/**\n * DigitalPersona Web Enroll (DPWebEnroll) service interface.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IEnrollService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IEnrollService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(CreateUser:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "CreateUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "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": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "password", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "CreateUser" }, { "kind": "MethodSignature", "canonicalReference": "(CustomAction:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "CustomAction" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "actionId" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "actionId", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "CustomAction" }, { "kind": "MethodSignature", "canonicalReference": "(DeleteAltusUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DeleteAltusUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "DeleteAltusUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(DeleteUser:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DeleteUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "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": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DeleteUser" }, { "kind": "MethodSignature", "canonicalReference": "(DeleteUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DeleteUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "owner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "owner", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "DeleteUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(EnrollAltusUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "EnrollAltusUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "EnrollAltusUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(EnrollUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "EnrollUserCredentials" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "owner" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "owner", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "EnrollUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(GetEnrollmentData:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetEnrollmentData" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "GetEnrollmentData" }, { "kind": "MethodSignature", "canonicalReference": "(GetUserAttribute:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetUserAttribute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "attributeName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "attributeName", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetUserAttribute" }, { "kind": "MethodSignature", "canonicalReference": "(GetUserCredentials:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetUserCredentials" }, { "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": "CredentialId" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "GetUserCredentials" }, { "kind": "MethodSignature", "canonicalReference": "(IsEnrollmentAllowed:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "IsEnrollmentAllowed" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "securityOfficer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credentialId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "securityOfficer", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "credentialId", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "IsEnrollmentAllowed" }, { "kind": "MethodSignature", "canonicalReference": "(PutUserAttribute:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "PutUserAttribute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "attribute" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Attribute" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AttributeAction" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "attribute", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "PutUserAttribute" }, { "kind": "MethodSignature", "canonicalReference": "(UnlockUser:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "UnlockUser" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "credential" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Credential" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "credential", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "UnlockUser" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IPolicyService:interface)", "docComment": "/**\n * DigitalPersona Web Policy (DPWebPolicy) service interface.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IPolicyService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IPolicyService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(GetPolicyInfo:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetPolicyInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "resourceUri" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ResourceActions" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "info" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PolicyInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "resourceUri", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "GetPolicyInfo" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(ISecretService:interface)", "docComment": "/**\n * DigitalPersona Web Secret (DPWebSecret) service interface.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ISecretService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ISecretService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(DeleteSecret:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DeleteSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DeleteSecret" }, { "kind": "MethodSignature", "canonicalReference": "(DoesSecretExist:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DoesSecretExist" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DoesSecretExist" }, { "kind": "MethodSignature", "canonicalReference": "(GetAuthPolicy:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "GetAuthPolicy" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ResourceActions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Policy" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetAuthPolicy" }, { "kind": "MethodSignature", "canonicalReference": "(ReadSecret:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ReadSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ReadSecret" }, { "kind": "MethodSignature", "canonicalReference": "(WriteSecret:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "WriteSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "secretData", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "WriteSecret" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(IService:interface)", "docComment": "/**\n * Web Access service base class.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "IService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "IService", "members": [ { "kind": "MethodSignature", "canonicalReference": "(Ping:0)", "docComment": "/**\n * Pings the service endpoint to detect connectivity status.\n *\n * @returns `true` on success, `false` on failure. The promise is never rejected.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Ping" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "Ping" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(LicenseInfo:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "LicenseInfo" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "LicenseInfo", "members": [ { "kind": "PropertySignature", "canonicalReference": "licenses_deployed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "licenses_deployed" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "licenses_deployed", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "licenses_used", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "licenses_used" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "licenses_used", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "LicenseType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(LicenseType:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "LicenseType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "LicenseType", "members": [ { "kind": "EnumMember", "canonicalReference": "ADUser", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ADUser" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "ADUser", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "LDSUser", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "LDSUser" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "LDSUser", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Interface", "canonicalReference": "(Policy:interface)", "docComment": "/**\n * A single authentication policy rule, as a list of {@link PolicyElement | policy elements}. When matching a list of {@CredentialUsed | used credentials} against the policy, the policy is satisfied when **every** {@link PolicyElement | policy elements} in the list is satisfied too.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Policy" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Policy", "members": [ { "kind": "PropertySignature", "canonicalReference": "policy", "docComment": "/**\n * A list of {@link PolicyElement | policy elements} to match against a list of {@CredentialUsed | used credentials}.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "policy" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "PolicyElement" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "policy", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(PolicyElement:interface)", "docComment": "/**\n * A single authentication policy element. Used to match {@CredentialUsed | used credentials} against the policy.\\ The policy element is satisfied when a list of {@CredentialUsed | used credentials} contains the {@link PolicyElement.cred_id}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PolicyElement" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PolicyElement", "members": [ { "kind": "PropertySignature", "canonicalReference": "cred_id", "docComment": "/**\n * {@link CredentialId} to match against a list of {@CredentialUsed | used credentials}.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "cred_id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "CredentialId" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "cred_id", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(PolicyInfo:interface)", "docComment": "/**\n * An information about authentication policy.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PolicyInfo" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PolicyInfo", "members": [ { "kind": "PropertySignature", "canonicalReference": "policyList", "docComment": "/**\n * A list of policy rules. The policy is satisfied when **any** of the rules in the list is satisfied.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "policyList" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Policy" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "policyList", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "policyTriggers", "docComment": "/**\n * A list of step-up triggers.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "policyTriggers" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "PolicyTrigger" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "policyTriggers", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(PolicyService:class)", "docComment": "/**\n * DigitalPersona Web Policy (DPWebPolicy) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "PolicyService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "IPolicyService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PolicyService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(GetPolicyInfo:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetPolicyInfo" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "resourceUri" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ResourceActions" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "info" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PolicyInfo" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "resourceUri", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } }, { "parameterName": "info", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "GetPolicyInfo" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "(PolicyTrigger:interface)", "docComment": "/**\n * A policy step-up trigger.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PolicyTrigger" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PolicyTrigger", "members": [ { "kind": "PropertySignature", "canonicalReference": "trigger", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "trigger" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TriggerNames" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "trigger", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(PSKCOutput:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PSKCOutput" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PSKCOutput", "members": [ { "kind": "PropertySignature", "canonicalReference": "error", "docComment": "/**\n * An errror occurred during OTP token import. The error is 0 if OTP token is imported successfully.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "error" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "error", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "error_text", "docComment": "/**\n * An error message if OTP token failed to import.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "error_text" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "error_text", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "serial_number", "docComment": "/**\n * A serial number of the hardware OTP token imported.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "serial_number" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "serial_number", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(ResourceActions:enum)", "docComment": "/**\n * Enumerates supported resource actions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "ResourceActions" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ResourceActions", "members": [ { "kind": "EnumMember", "canonicalReference": "Delete", "docComment": "/**\n * Deleting a resource.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Delete" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Delete", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Read", "docComment": "/**\n * Reading of a resource.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Read" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Read", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Write", "docComment": "/**\n * Modifying a resource.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Write" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Write", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Interface", "canonicalReference": "(SearchQuery:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "SearchQuery" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SearchQuery", "members": [ { "kind": "PropertySignature", "canonicalReference": "attributes", "docComment": "/**\n * A list of strings with object attributes requested. NOTE: the bigger list of attributes requested, the slower the search, and the larger amount of data to be transferred over networks.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "attributes" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "attributes", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "baseDN", "docComment": "/**\n * A distinguished name of the entry at which to start the search. This is an optional parameter and if it set to `null` we will perform the search from a default base (an AD root for the DPCA AD Server, LDS partition root for the DPCA LDS Server)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "baseDN" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "baseDN", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "filter", "docComment": "/**\n * A search filter. Check https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx for LDAP filter syntax.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "filter", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "scope", "docComment": "/**\n * A scope of the search.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "scope" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "SearchScope" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "sort", "docComment": "/**\n * A name of the attribute to perform result sorting. For example, `\"cn\"` will sort users search results based on the “cn” (Common Name) attribute. NOTE: Sorting can be performed only on indexed attributes. This is optional parameter and it can be set to null if sorting is not required.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "sort" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sort", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(SearchScope:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "SearchScope" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SearchScope", "members": [ { "kind": "EnumMember", "canonicalReference": "Base", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Base" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Base", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "OneLevel", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "OneLevel" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "OneLevel", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Subtree", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Subtree" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Subtree", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(SecretService:class)", "docComment": "/**\n * DigitalPersona Web Secret (DPWebSecret) service client wrapper.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "SecretService" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Service" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "ISecretService" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SecretService", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a service wrapper.\n *\n * @param endpointUrl - a URL to the DPWebClaims service.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "endpointUrl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "endpointUrl", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(DeleteSecret:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DeleteSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DeleteSecret" }, { "kind": "Method", "canonicalReference": "(DoesSecretExist:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "DoesSecretExist" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "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": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "DoesSecretExist" }, { "kind": "Method", "canonicalReference": "(GetAuthPolicy:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "GetAuthPolicy" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "user" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "action" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ResourceActions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Policy" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "user", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "action", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "GetAuthPolicy" }, { "kind": "Method", "canonicalReference": "(ReadSecret:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ReadSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ReadSecret" }, { "kind": "Method", "canonicalReference": "(WriteSecret:instance,0)", "docComment": "/**\n * @inheritdoc\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "WriteSecret" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ticket" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Ticket" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "secretData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "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": "ticket", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "secretName", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "secretData", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "WriteSecret" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Enum", "canonicalReference": "(ServerSettings:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "ServerSettings" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ServerSettings", "members": [ { "kind": "EnumMember", "canonicalReference": "LockoutDuration", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "\"LockoutDuration\" = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "LockoutDuration", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "LockoutReset", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "\"LockoutReset\" = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "LockoutReset", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "EnumMember", "canonicalReference": "LockoutThreshold", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "\"LockoutThreshold\" = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "LockoutThreshold", "initializerTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Enum", "canonicalReference": "(ServerSettingType:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "ServerSettingType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ServerSettingType", "members": [ { "kind": "EnumMember", "canonicalReference": "Admin", "docComment": "/**\n * Server Settings will be accessible only for Domain Administrators.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Admin" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Admin", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Public", "docComment": "/**\n * Server Settings will be accessible for anybody (public).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Public" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Public", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Unknown", "docComment": "/**\n * Unknown Server Settings Type.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Unknown" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Unknown", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Class", "canonicalReference": "(ServiceError:class)", "docComment": "/**\n * Maps Web Access service faults to the Javascript exception model\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ServiceError" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ServiceError", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs the object.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "message" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "code", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "message", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] }, { "kind": "Property", "canonicalReference": "(code:instance)", "docComment": "/**\n * Numeric code of the error. In case of HTTP error the code will be an HTTP status code. In case of {@link ServiceFault | service fault} the code will be an HRESULT server code.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(fromServiceFault:static,0)", "docComment": "/**\n * Creates a service error object from a {@link ServiceFault | service fault}.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "fromServiceFault" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "fault" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ServiceFault" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ServiceError" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "fault", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "fromServiceFault" }, { "kind": "Method", "canonicalReference": "(isHttpError:instance,0)", "docComment": "/**\n * Allows to distinguish transport errors (HTTP) from {@link ServiceFault | service faults}.\n *\n * @returns `true` if the error was a transport error (HTTP), `false` if it was a {@link ServiceFault | service fault}.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "isHttpError" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "isHttpError" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(ServiceFault:interface)", "docComment": "/**\n * A server fault object. When server error occurs, the server returns the fault object in a response body.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ServiceFault" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ServiceFault", "members": [ { "kind": "PropertySignature", "canonicalReference": "description", "docComment": "/**\n * A text describing the error.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "description" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "description", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "error_code", "docComment": "/**\n * A numeric code of the error.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "error_code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "error_code", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(TriggerName:enum)", "docComment": "/**\n * Enumerates step-up triggers.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "TriggerName" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TriggerName", "members": [ { "kind": "EnumMember", "canonicalReference": "AltusInstalled", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "AltusInstalled" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"altusInstalled\"" } ], "releaseTag": "Public", "name": "AltusInstalled", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Behavior", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Behavior" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"behavior\"" } ], "releaseTag": "Public", "name": "Behavior", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Computer", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Computer" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"computer\"" } ], "releaseTag": "Public", "name": "Computer", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Device", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Device" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"device\"" } ], "releaseTag": "Public", "name": "Device", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Domain", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "Domain" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"domain\"" } ], "releaseTag": "Public", "name": "Domain", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "InsideFirewall", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "InsideFirewall" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"insideFirewall\"" } ], "releaseTag": "Public", "name": "InsideFirewall", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "IP", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "IP" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"ip\"" } ], "releaseTag": "Public", "name": "IP", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RemoteSession", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RemoteSession" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"remoteSession\"" } ], "releaseTag": "Public", "name": "RemoteSession", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "User", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "User" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"user\"" } ], "releaseTag": "Public", "name": "User", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Enum", "canonicalReference": "(UACFlags:enum)", "docComment": "/**\n * DPCA Useraccount control flags.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "UACFlags" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "UACFlags", "members": [ { "kind": "EnumMember", "canonicalReference": "FingerprintOnly", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "FingerprintOnly" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "16" } ], "releaseTag": "Public", "name": "FingerprintOnly", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "FingerprintRequired", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "FingerprintRequired" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "8" } ], "releaseTag": "Public", "name": "FingerprintRequired", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "OtpAndFingerprint", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "OtpAndFingerprint" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "128" } ], "releaseTag": "Public", "name": "OtpAndFingerprint", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "OtpAndPwd", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "OtpAndPwd" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "64" } ], "releaseTag": "Public", "name": "OtpAndPwd", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "PasswordNotAllowed", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "PasswordNotAllowed" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "PasswordNotAllowed", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "PinRequired", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "PinRequired" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "PinRequired", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "RevertToWindows", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RevertToWindows" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "RevertToWindows", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Enum", "canonicalReference": "(UserAccountType:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "UserAccountType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "UserAccountType", "members": [ { "kind": "EnumMember", "canonicalReference": "ActiveDirectory", "docComment": "/**\n * ActiveDirectory user\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ActiveDirectory" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "ActiveDirectory", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "ADLDS", "docComment": "/**\n * AD LDS (DPCA) user.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ADLDS" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "ADLDS", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Local", "docComment": "/**\n * A local user account.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Local" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Local", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Unknown", "docComment": "/**\n * User account type is unknown.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Unknown" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "0" } ], "releaseTag": "Public", "name": "Unknown", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Interface", "canonicalReference": "(UserInfo:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "UserInfo" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "UserInfo", "members": [ { "kind": "PropertySignature", "canonicalReference": "accountControl", "docComment": "/**\n * User account control bits, stored in the `dpUserAccountControl` attribute of the user's LDAP record.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "accountControl" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "UACFlags" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "accountControl", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "displayName", "docComment": "/**\n * User's display name, stored in the `displayName` attribute of the user's LDAP record.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "displayName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "displayName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "licensed", "docComment": "/**\n * `true` if the user holds DPCA license.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "licensed" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "licensed", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "locked", "docComment": "/**\n * `true` if user account locked.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "locked" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "locked", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "/**\n * User account type.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "UserAccountType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "uid", "docComment": "/**\n * User's unuque identifier (UID), stored in the `objectGUID` attribute of the user's LDAP record.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "uid" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "uid", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(VarBlob:class)", "docComment": "/**\n * A variant data holding a binary object (in a form of a Base64Url-encoded string).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "VarBlob" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "VarBlob", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `VarBlob` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ] }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "VarType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Blob" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(values:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Base64UrlString" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(VarBool:class)", "docComment": "/**\n * A variant data holding a boolean value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "VarBool" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "VarBool", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `VarBool` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "VarType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(values:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(VarInt:class)", "docComment": "/**\n * A variant data holding an integer value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "VarInt" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "VarInt", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `VarInt` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "VarType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Integer" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(values:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(VarString:class)", "docComment": "/**\n * A variant data holding a string value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "VarString" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "VarString", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `VarString` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "values", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "VarType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "String" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(values:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "values" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "values", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(VarType:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "VarType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "VarType", "members": [ { "kind": "EnumMember", "canonicalReference": "Blob", "docComment": "/**\n * The variant holds a binary object (in a form of a Base64Url-encoded string).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Blob" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "4" } ], "releaseTag": "Public", "name": "Blob", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Boolean", "docComment": "/**\n * The variant holds a boolean value.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Boolean" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "1" } ], "releaseTag": "Public", "name": "Boolean", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "Integer", "docComment": "/**\n * The variant holds an integer value.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "Integer" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "2" } ], "releaseTag": "Public", "name": "Integer", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "String", "docComment": "/**\n * The variant holds a string value.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "String" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "3" } ], "releaseTag": "Public", "name": "String", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "TypeAlias", "canonicalReference": "ADAttributeName", "docComment": "/**\n * Branded alias type for ActiveDirectory attribute names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ADAttributeName" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "brand" }, { "kind": "Content", "text": "?: \"dp.services.ADAttributeName\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ADAttributeName", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "AttributeName", "docComment": "/**\n * Supported types of attribute names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "AttributeName" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "ADAttributeName" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "LDSAttributeName" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "AttributeName", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "AuthenticationHandle", "docComment": "/**\n * Branded alias type for an authentication handle.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "AuthenticationHandle" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "number & {\n " }, { "kind": "Reference", "text": "brand" }, { "kind": "Content", "text": "?: \"dp.services.AuthenticationHandle\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "AuthenticationHandle", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "LDSAttributeName", "docComment": "/**\n * Branded alias type for Lightweight Directory Service (LDS) attribute names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "LDSAttributeName" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string & {\n " }, { "kind": "Reference", "text": "brand" }, { "kind": "Content", "text": "?: \"dp.services.LDSAttributeName\";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "LDSAttributeName", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "TypeAlias", "canonicalReference": "TriggerNames", "docComment": "/**\n * Alias type for supported step-up trigger names.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "TriggerNames" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " in keyof " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "] extends " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": " ? never : " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ";\n}[keyof " }, { "kind": "Reference", "text": "ContextualInfo" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TriggerNames", "typeTokenRange": { "startIndex": 3, "endIndex": 18 } }, { "kind": "TypeAlias", "canonicalReference": "VarData", "docComment": "/**\n * A variant data.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "VarData" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "VarBool" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "VarInt" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "VarString" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "VarBlob" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "VarData", "typeTokenRange": { "startIndex": 3, "endIndex": 10 } } ] } ] }