@digitalpersona/services
Version:
DigitalPersona Web Access Services
78 lines (66 loc) • 6.03 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@digitalpersona/services](./services.md)
## services package
## Classes
| Class | Description |
| --- | --- |
| [AdminService](./services.adminservice.md) | DigitalPersona WebAuth (DPWebAuth) service client wrapper. |
| [AuthenticationData](./services.authenticationdata.md) | Client-side authentication data used by the [IAuthenticationClient](./services.iauthenticationclient.md) during authentication handshake. |
| [AuthService](./services.authservice.md) | DigitalPersona WebAuth (DPWebAuth) service client wrapper. |
| [ClaimRequest](./services.claimrequest.md) | A request for a identity claim. The service will search an [attribute](./services.claimrequest.attr.md) in a and return the attribute value as a claim [name](./services.claimrequest.name.md) in a token. |
| [ClaimsService](./services.claimsservice.md) | DigitalPersona Web Claims (DPWebClaims) service client wrapper. |
| [ContextualInfo](./services.contextualinfo.md) | A context of an authentication. |
| [EnrollService](./services.enrollservice.md) | DigitalPersona Web Enroll (DPWebEnroll) service client wrapper. |
| [PolicyService](./services.policyservice.md) | DigitalPersona Web Policy (DPWebPolicy) service client wrapper. |
| [SecretService](./services.secretservice.md) | DigitalPersona Web Secret (DPWebSecret) service client wrapper. |
| [ServiceError](./services.serviceerror.md) | Maps Web Access service faults to the Javascript exception model |
| [VarBlob](./services.varblob.md) | A variant data holding a binary object (in a form of a Base64Url-encoded string). |
| [VarBool](./services.varbool.md) | A variant data holding a boolean value. |
| [VarInt](./services.varint.md) | A variant data holding an integer value. |
| [VarString](./services.varstring.md) | A variant data holding a string value. |
## Enumerations
| Enumeration | Description |
| --- | --- |
| [AttributeAction](./services.attributeaction.md) | Enumerates supported actions that can be performed on user's attributes. |
| [AuthenticationStatus](./services.authenticationstatus.md) | Enumerated possible authentication statuses. |
| [DatabaseType](./services.databasetype.md) | Enumerates supported identity databases. |
| [LicenseType](./services.licensetype.md) | |
| [ResourceActions](./services.resourceactions.md) | Enumerates supported resource actions. |
| [SearchScope](./services.searchscope.md) | |
| [ServerSettings](./services.serversettings.md) | |
| [ServerSettingType](./services.serversettingtype.md) | |
| [TriggerName](./services.triggername.md) | Enumerates step-up triggers. |
| [UACFlags](./services.uacflags.md) | DPCA Useraccount control flags. |
| [UserAccountType](./services.useraccounttype.md) | |
| [VarType](./services.vartype.md) | |
## Interfaces
| Interface | Description |
| --- | --- |
| [Attribute](./services.attribute.md) | A named attribute with a variant data value. |
| [ExtendedAuthResult](./services.extendedauthresult.md) | Result of authentication handshake containing and optional authentication data payload. |
| [IAdminService](./services.iadminservice.md) | DigitalPersona Web Administration (DPWebAdmin) service interface. |
| [IAuthenticationClient](./services.iauthenticationclient.md) | Set of methods to support an authentication handshake protocol on a client side. |
| [IAuthService](./services.iauthservice.md) | DigitalPersona Web Authentication (DPWebAuth) service interface. |
| [IClaimsService](./services.iclaimsservice.md) | DigitalPersona Web Claims (DPWebClaims) service interface.<!-- -->This service allows to request additional claims to be added to the JSON Web Token issued by the AuthService. |
| [IEnrollService](./services.ienrollservice.md) | DigitalPersona Web Enroll (DPWebEnroll) service interface. |
| [IPolicyService](./services.ipolicyservice.md) | DigitalPersona Web Policy (DPWebPolicy) service interface. |
| [ISecretService](./services.isecretservice.md) | DigitalPersona Web Secret (DPWebSecret) service interface. |
| [IService](./services.iservice.md) | Web Access service base class. |
| [LicenseInfo](./services.licenseinfo.md) | |
| [Policy](./services.policy.md) | A single authentication policy rule, as a list of [policy elements](./services.policyelement.md)<!-- -->. When matching a list of against the policy, the policy is satisfied when \*\*every\*\* [policy elements](./services.policyelement.md) in the list is satisfied too. |
| [PolicyElement](./services.policyelement.md) | A single authentication policy element. Used to match against the policy.<!-- -->\\ The policy element is satisfied when a list of contains the [PolicyElement.cred\_id](./services.policyelement.cred_id.md)<!-- -->. |
| [PolicyInfo](./services.policyinfo.md) | An information about authentication policy. |
| [PolicyTrigger](./services.policytrigger.md) | A policy step-up trigger. |
| [PSKCOutput](./services.pskcoutput.md) | |
| [SearchQuery](./services.searchquery.md) | |
| [ServiceFault](./services.servicefault.md) | A server fault object. When server error occurs, the server returns the fault object in a response body. |
| [UserInfo](./services.userinfo.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [ADAttributeName](./services.adattributename.md) | Branded alias type for ActiveDirectory attribute names. |
| [AttributeName](./services.attributename.md) | Supported types of attribute names. |
| [AuthenticationHandle](./services.authenticationhandle.md) | Branded alias type for an authentication handle. |
| [LDSAttributeName](./services.ldsattributename.md) | Branded alias type for Lightweight Directory Service (LDS) attribute names. |
| [TriggerNames](./services.triggernames.md) | Alias type for supported step-up trigger names. |
| [VarData](./services.vardata.md) | A variant data. |