PeerIdentity
Defined in: src/identity.ts:317
Immutable verified or observed transport-peer evidence.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PeerIdentity(options): PeerIdentity;Defined in: src/identity.ts:347
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
PeerIdentityOptions |
Returns
Section titled “Returns”PeerIdentity
Properties
Section titled “Properties”assurance
Section titled “assurance”readonly assurance: IdentityAssurance;Defined in: src/identity.ts:323
Mechanism that established the identity.
attributes
Section titled “attributes”readonly attributes: Readonly<Record<string, JsonValue>>;Defined in: src/identity.ts:337
Immutable additional facts about the peer.
capabilities
Section titled “capabilities”readonly capabilities: Readonly<Record<string, JsonValue>>;Defined in: src/identity.ts:339
Immutable permissions or features reported for the peer.
capabilitiesVerified
Section titled “capabilitiesVerified”readonly capabilitiesVerified: boolean;Defined in: src/identity.ts:341
Whether the provider verified the reported capabilities.
evidenceSource
Section titled “evidenceSource”readonly evidenceSource: string;Defined in: src/identity.ts:321
Concrete source from which the evidence was obtained.
issuer
Section titled “issuer”readonly issuer: string;Defined in: src/identity.ts:325
Namespace that issued the subject key.
provider
Section titled “provider”readonly provider: string;Defined in: src/identity.ts:319
Provider that produced the evidence.
proxyAddress?
Section titled “proxyAddress?”readonly optional proxyAddress?: string;Defined in: src/identity.ts:345
Address of the trusted proxy that supplied the evidence.
sourceAddress?
Section titled “sourceAddress?”readonly optional sourceAddress?: string;Defined in: src/identity.ts:343
Original source address observed for the peer.
subjectKey?
Section titled “subjectKey?”readonly optional subjectKey?: string;Defined in: src/identity.ts:331
Provider-specific subject identifier, when available.
subjectKind
Section titled “subjectKind”readonly subjectKind: PeerSubjectKind;Defined in: src/identity.ts:329
Category of the identified subject.
subjectStability
Section titled “subjectStability”readonly subjectStability: SubjectStability;Defined in: src/identity.ts:333
Lifetime over which the subject key remains stable.
subjectVerified
Section titled “subjectVerified”readonly subjectVerified: boolean;Defined in: src/identity.ts:335
Whether the provider verified the subject key.
transport
Section titled “transport”readonly transport: string;Defined in: src/identity.ts:327
Transport on which the peer was observed.
Accessors
Section titled “Accessors”canonicalPrincipal
Section titled “canonicalPrincipal”Get Signature
Section titled “Get Signature”get canonicalPrincipal(): string;Defined in: src/identity.ts:390
Canonical VGI principal derived from the provider, issuer, and subject.
Returns
Section titled “Returns”string