Skip to main content

@hyperledger/identus-edge-agent-sdk / Exports / JWTCredential

Class: JWTCredential

Storable define properties a Domain object must implement to be compatible with Pluto

Hierarchy​

Implements​

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

• new JWTCredential(payload, revoked?): JWTCredential

Parameters​

NameType
payloadstring
revoked?boolean

Returns​

JWTCredential

Overrides​

Credential.constructor

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:33

• new JWTCredential(payload, revoked?): JWTCredential

Parameters​

NameType
payloadJWTCredentialPayload | JWTPresentationPayload
revoked?boolean

Returns​

JWTCredential

Overrides​

Credential.constructor

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:34

Properties​

credentialType​

• credentialType: CredentialType = CredentialType.JWT

Overrides​

Credential.credentialType

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:29

properties​

• properties: Map<JWTVerifiableCredentialProperties | JWTVerifiablePresentationProperties, any>

Overrides​

Credential.properties

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:31

recoveryId​

• recoveryId: string = JWTVerifiableCredentialRecoveryId

Overrides​

Credential.recoveryId

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:30

uuid​

• Readonly uuid: string

Universally Unique Identifier. should be unique across all items.

Implementation of​

Storable.uuid

Inherited from​

Credential.uuid

Defined in​

src/domain/models/Credential.ts:17

Accessors​

audience​

• get audience(): any

Returns​

any

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:334

claims​

• get claims(): Record<string, any>[]

Returns​

Record<string, any>[]

Overrides​

Credential.claims

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:291

context​

• get context(): undefined | [credential]

Returns​

undefined | [credential]

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:300

credentialSchema​

• get credentialSchema(): undefined | { id: string ; type: string }

Returns​

undefined | { id: string ; type: string }

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:304

credentialStatus​

• get credentialStatus(): unknown

Returns​

unknown

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:308

credentialSubject​

• get credentialSubject(): undefined | Record<string, any>

Returns​

undefined | Record<string, any>

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:312

evidence​

• get evidence(): undefined | { id: string ; type: string }

Returns​

undefined | { id: string ; type: string }

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:316

expirationDate​

• get expirationDate(): undefined | string

Returns​

undefined | string

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:320

id​

• get id(): any

Returns​

any

Overrides​

Credential.id

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:267

isCredential​

• get isCredential(): boolean

Returns​

boolean

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:263

issuanceDate​

• get issuanceDate(): string

Returns​

string

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:327

issuer​

• get issuer(): any

Returns​

any

Overrides​

Credential.issuer

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:341

refreshService​

• get refreshService(): undefined | { id: string ; type: string }

Returns​

undefined | { id: string ; type: string }

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:348

revoked​

• get revoked(): undefined | boolean

Returns​

undefined | boolean

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:360

subject​

• get subject(): string

Returns​

string

Overrides​

Credential.subject

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:352

termsOfUse​

• get termsOfUse(): undefined | { id: string ; type: string }

Returns​

undefined | { id: string ; type: string }

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:368

type​

• get type(): undefined | [credential] | [presentation]

Returns​

undefined | [credential] | [presentation]

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:372

vc​

• get vc(): undefined | W3CVerifiableCredential

Returns​

undefined | W3CVerifiableCredential

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:275

vp​

• get vp(): undefined | W3CVerifiablePresentation

Returns​

undefined | W3CVerifiablePresentation

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:283

Methods​

getProperty​

▸ getProperty(name): any

Parameters​

NameType
namestring

Returns​

any

Inherited from​

Credential.getProperty

Defined in​

src/domain/models/Credential.ts:19

isCredentialPayload​

▸ isCredentialPayload(payload): payload is JWTCredentialPayload

Parameters​

NameType
payloadany

Returns​

payload is JWTCredentialPayload

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:181

isProvable​

▸ isProvable(): this is ProvableCredential

Returns​

this is ProvableCredential

Inherited from​

Credential.isProvable

Defined in​

src/domain/models/Credential.ts:23

isRevoked​

▸ isRevoked(): boolean

Returns​

boolean

Inherited from​

Credential.isRevoked

Defined in​

src/domain/models/Credential.ts:31

isStorable​

▸ isStorable(): this is StorableCredential

Returns​

this is StorableCredential

Inherited from​

Credential.isStorable

Defined in​

src/domain/models/Credential.ts:27

presentation​

▸ presentation(): W3CVerifiablePresentation

Returns​

W3CVerifiablePresentation

Implementation of​

ProvableCredential.presentation

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:376

toStorable​

▸ toStorable(): Object

Returns​

Object

NameType
availableClaimsstring[]
credentialDatastring
idany
issuerany
recoveryIdstring
revokedundefined | boolean
subjectany
validUntilany

Implementation of​

StorableCredential.toStorable

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:411

verifiableCredential​

▸ verifiableCredential(): W3CVerifiableCredential

Returns​

W3CVerifiableCredential

Implementation of​

ProvableCredential.verifiableCredential

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:393

fromJWS​

▸ fromJWS(jws, revoked?): JWTCredential

Parameters​

NameType
jwsstring
revoked?boolean

Returns​

JWTCredential

Defined in​

src/pollux/models/JWTVerifiableCredential.ts:177