JWTCredential

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / overview / JWTCredential

Class: JWTCredential

Defined in: src/pollux/models/JWTVerifiableCredential.ts:51

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

Extends

• Credential

Implements

• ProvableCredential
• StorableCredential
• Storable

Constructors

Constructor

new JWTCredential(payload: string, revoked?: boolean): JWTCredential

Defined in: src/pollux/models/JWTVerifiableCredential.ts:59

Parameters

Parameter	Type
payload	string
revoked?	boolean

Returns

JWTCredential

Overrides

Credential.constructor

Constructor

new JWTCredential(payload: JWTCredentialPayload | JWTPresentationPayload, revoked?: boolean): JWTCredential

Defined in: src/pollux/models/JWTVerifiableCredential.ts:60

Parameters

Parameter	Type
payload	JWTCredentialPayload | JWTPresentationPayload
revoked?	boolean

Returns

JWTCredential

Overrides

Credential.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
credentialType	public	CredentialType	CredentialType.JWT	-	Credential.credentialType	-	src/pollux/models/JWTVerifiableCredential.ts:55
properties	public	Map<Claims | JWT_VC_PROPS | JWT_VP_PROPS, any>	undefined	-	Credential.properties	-	src/pollux/models/JWTVerifiableCredential.ts:57
recoveryId	public	string	JWTVerifiableCredentialRecoveryId	-	Credential.recoveryId	-	src/pollux/models/JWTVerifiableCredential.ts:56
uuid	readonly	string	undefined	Universally Unique Identifier. should be unique across all items.	-	Storable.uuid Credential.uuid	src/domain/models/Credential.ts:15

Accessors

audience

Get Signature

get audience(): any

Defined in: src/pollux/models/JWTVerifiableCredential.ts:359

Returns

any

---

claims

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:316

Returns

Record<string, any>[]

Overrides

Credential.claims

---

context

Get Signature

get context(): ["https://www.w3.org/2018/credentials/v1"] | ["https://www.w3.org/2018/presentations/v1"] | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:325

Returns

["https://www.w3.org/2018/credentials/v1"] | ["https://www.w3.org/2018/presentations/v1"] | undefined

---

credentialSchema

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:329

Returns

{ id: string; type: string; } | undefined

---

credentialStatus

Get Signature

get credentialStatus(): unknown

Defined in: src/pollux/models/JWTVerifiableCredential.ts:333

Returns

unknown

---

credentialSubject

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:337

Returns

Record<string, any> | undefined

---

evidence

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:341

Returns

{ id: string; type: string; } | undefined

---

expirationDate

Get Signature

get expirationDate(): string | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:345

Returns

string | undefined

---

id

Get Signature

get id(): any

Defined in: src/pollux/models/JWTVerifiableCredential.ts:292

Returns

any

Overrides

Credential.id

---

isCredential

Get Signature

get isCredential(): boolean

Defined in: src/pollux/models/JWTVerifiableCredential.ts:288

Returns

boolean

---

issuanceDate

Get Signature

get issuanceDate(): string

Defined in: src/pollux/models/JWTVerifiableCredential.ts:352

Returns

string

---

issuer

Get Signature

get issuer(): any

Defined in: src/pollux/models/JWTVerifiableCredential.ts:366

Returns

any

Overrides

Credential.issuer

---

refreshService

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:373

Returns

{ id: string; type: string; } | undefined

---

revoked

Get Signature

get revoked(): boolean | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:385

Returns

boolean | undefined

---

subject

Get Signature

get subject(): string

Defined in: src/pollux/models/JWTVerifiableCredential.ts:377

Returns

string

Overrides

Credential.subject

---

termsOfUse

Get Signature

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

Defined in: src/pollux/models/JWTVerifiableCredential.ts:393

Returns

{ id: string; type: string; } | undefined

---

type

Get Signature

get type(): ["VerifiableCredential"] | ["VerifiablePresentation"] | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:397

Returns

["VerifiableCredential"] | ["VerifiablePresentation"] | undefined

---

vc

Get Signature

get vc(): W3CVerifiableCredential | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:300

Returns

W3CVerifiableCredential | undefined

---

vp

Get Signature

get vp(): W3CVerifiablePresentation | undefined

Defined in: src/pollux/models/JWTVerifiableCredential.ts:308

Returns

W3CVerifiablePresentation | undefined

Methods

getProperty()

getProperty(name: string): any

Defined in: src/domain/models/Credential.ts:17

Parameters

Parameter	Type
name	string

Returns

any

Inherited from

Credential.getProperty

---

isProvable()

isProvable(): this is ProvableCredential

Defined in: src/domain/models/Credential.ts:21

Returns

this is ProvableCredential

Inherited from

Credential.isProvable

---

isRevoked()

isRevoked(): boolean

Defined in: src/domain/models/Credential.ts:29

Returns

boolean

Inherited from

Credential.isRevoked

---

isStorable()

isStorable(): this is StorableCredential

Defined in: src/domain/models/Credential.ts:25

Returns

this is StorableCredential

Inherited from

Credential.isStorable

---

presentation()

presentation(): W3CVerifiablePresentation

Defined in: src/pollux/models/JWTVerifiableCredential.ts:401

Returns

W3CVerifiablePresentation

Implementation of

ProvableCredential.presentation

---

toStorable()

toStorable(): { availableClaims: string[]; credentialData: string; id: any; issuer: any; recoveryId: string; revoked: boolean | undefined; subject: any; validUntil: any; }

Defined in: src/pollux/models/JWTVerifiableCredential.ts:432

Returns

{ availableClaims: string[]; credentialData: string; id: any; issuer: any; recoveryId: string; revoked: boolean | undefined; subject: any; validUntil: any; }

Name	Type	Default value	Defined in
availableClaims	string[]	claims	src/pollux/models/JWTVerifiableCredential.ts:443
credentialData	string	-	src/pollux/models/JWTVerifiableCredential.ts:439
id	any	-	src/pollux/models/JWTVerifiableCredential.ts:437
issuer	any	-	src/pollux/models/JWTVerifiableCredential.ts:440
recoveryId	string	-	src/pollux/models/JWTVerifiableCredential.ts:438
revoked	boolean | undefined	-	src/pollux/models/JWTVerifiableCredential.ts:444
subject	any	-	src/pollux/models/JWTVerifiableCredential.ts:441
validUntil	any	-	src/pollux/models/JWTVerifiableCredential.ts:442

Implementation of

StorableCredential.toStorable

---

verifiableCredential()

verifiableCredential(): W3CVerifiableCredential

Defined in: src/pollux/models/JWTVerifiableCredential.ts:418

Returns

W3CVerifiableCredential

Implementation of

ProvableCredential.verifiableCredential

---

fromJWS()

static fromJWS(jws: string, revoked?: boolean): JWTCredential

Defined in: src/pollux/models/JWTVerifiableCredential.ts:203

Parameters

Parameter	Type
jws	string
revoked?	boolean

Returns

JWTCredential