PeerEvidenceSet
Defined in: src/identity.ts:436
Immutable aggregate of one result per configured provider.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PeerEvidenceSet(results?): PeerEvidenceSet;Defined in: src/identity.ts:443
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
results |
readonly PeerIdentityResult[] |
[] |
Returns
Section titled “Returns”PeerEvidenceSet
Properties
Section titled “Properties”identities
Section titled “identities”readonly identities: readonly PeerIdentity[];Defined in: src/identity.ts:440
All identities produced by configured providers.
readonly static EMPTY: PeerEvidenceSet;Defined in: src/identity.ts:438
Shared empty evidence set.
Methods
Section titled “Methods”bindingDigest()
Section titled “bindingDigest()”bindingDigest(providers, applicationAuth?): Promise<string>;Defined in: src/identity.ts:527
Computes a deterministic digest binding selected evidence to authentication.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
providers |
readonly string[] |
applicationAuth? |
AuthContext |
Returns
Section titled “Returns”Promise<string>
eligibleSubjects()
Section titled “eligibleSubjects()”eligibleSubjects(provider): readonly PeerIdentity[];Defined in: src/identity.ts:470
Returns verified, stable subjects eligible for authentication.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |
Returns
Section titled “Returns”readonly PeerIdentity[]
forProvider()
Section titled “forProvider()”forProvider(provider): readonly PeerIdentity[];Defined in: src/identity.ts:465
Returns all identities produced by a provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |
Returns
Section titled “Returns”readonly PeerIdentity[]
requireAvailableProvider()
Section titled “requireAvailableProvider()”requireAvailableProvider(provider): readonly PeerIdentity[];Defined in: src/identity.ts:506
Requires an operational provider with at least one identity.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |
Returns
Section titled “Returns”readonly PeerIdentity[]
requireUsableProvider()
Section titled “requireUsableProvider()”requireUsableProvider(provider): PeerIdentity;Defined in: src/identity.ts:491
Requires one verified stable subject from an operational provider.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |
Returns
Section titled “Returns”status()
Section titled “status()”status(provider): PeerIdentityStatus;Defined in: src/identity.ts:460
Returns a provider’s status, or off when it has no result.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |
Returns
Section titled “Returns”uniqueVerifiedSubject()
Section titled “uniqueVerifiedSubject()”uniqueVerifiedSubject(provider): PeerIdentity;Defined in: src/identity.ts:480
Returns the provider’s sole eligible subject or rejects ambiguity.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
provider |
string |