@digitalpersona/services
Version:
DigitalPersona Web Access Services
1,665 lines • 393 kB
JSON
{
"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": "<void>"
},
{
"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": "<string>"
},
{
"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": "<void>"
},
{
"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": "<void>"
},
{
"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": "<void>"
},
{
"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": "crede