JWTCredential
@hyperledger/identus-sdk v8.1.3
@hyperledger/identus-sdk / overview / JWTCredential
Class: JWTCredential
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:53
Storable define properties a Domain object must implement to be compatible with Pluto
Extends
Implements
Constructors
Constructor
new JWTCredential(
payload:string,revoked?:boolean):JWTCredential
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:101
Parameters
| Parameter | Type |
|---|---|
payload | string |
revoked? | boolean |
Returns
JWTCredential
Overrides
Constructor
new JWTCredential(
payload:JWTPresentationPayload|JWTCredentialPayload,revoked?:boolean):JWTCredential
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:102
Parameters
| Parameter | Type |
|---|---|
payload | JWTPresentationPayload | JWTCredentialPayload |
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 | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:97 |
properties | public | Map<Claims | JWT_VP_PROPS | JWT_VC_PROPS, any> | undefined | - | Credential.properties | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:99 |
recoveryId | public | string | JWTVerifiableCredentialRecoveryId | - | Credential.recoveryId | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:98 |
uuid | readonly | string | undefined | Universally Unique Identifier. should be unique across all items. | - | Storable.uuid Credential.uuid | packages/shared/domain/build/index.d.ts:338 |
Accessors
audience
Get Signature
get audience():
any
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:389
Returns
any
claims
Get Signature
get claims():
Record<string,any>[]
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:350
Returns
Record<string, any>[]
Overrides
context
Get Signature
get context(): [
"https://www.w3.org/2018/credentials/v1"] | ["https://www.w3.org/2018/presentations/v1"] |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:359
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: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:363
Returns
{ id: string; type: string; } | undefined
credentialStatus
Get Signature
get credentialStatus(): {
id:string;statusListCredential:string;statusListIndex:number;statusPurpose:"Revocation"|"Suspension";type:string; } |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:367
Returns
{ id: string; statusListCredential: string; statusListIndex: number; statusPurpose: "Revocation" | "Suspension"; type: string; } | undefined
credentialSubject
Get Signature
get credentialSubject():
Record<string,any> |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:371
Returns
Record<string, any> | undefined
evidence
Get Signature
get evidence(): {
id:string;type:string; } |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:375
Returns
{ id: string; type: string; } | undefined
expirationDate
Get Signature
get expirationDate():
string|undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:379
Returns
string | undefined
id
Get Signature
get id():
any
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:330
Returns
any
Overrides
isCredential
Get Signature
get isCredential():
boolean
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:326
Returns
boolean
issuanceDate
Get Signature
get issuanceDate():
string
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:384
Returns
string
issuer
Get Signature
get issuer():
string
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:394
Returns
string
Overrides
refreshService
Get Signature
get refreshService(): {
id:string;type:string; } |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:399
Returns
{ id: string; type: string; } | undefined
revoked
Get Signature
get revoked():
boolean|undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:411
Returns
boolean | undefined
subject
Get Signature
get subject():
string
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:403
Returns
string
Overrides
termsOfUse
Get Signature
get termsOfUse(): {
id:string;type:string; } |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:419
Returns
{ id: string; type: string; } | undefined
type
Get Signature
get type(): [
"VerifiableCredential"] | ["VerifiablePresentation"] |undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:423
Returns
["VerifiableCredential"] | ["VerifiablePresentation"] | undefined
vc
Get Signature
get vc():
W3CVerifiableCredential|undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:334
Returns
W3CVerifiableCredential | undefined
vp
Get Signature
get vp():
W3CVerifiablePresentation|undefined
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:342
Returns
W3CVerifiablePresentation | undefined
Methods
getProperty()
getProperty(
name:string):any
Defined in: packages/shared/domain/build/index.d.ts:339
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
any
Inherited from
isProvable()
isProvable():
this is ProvableCredential
Defined in: packages/shared/domain/build/index.d.ts:340
Returns
this is ProvableCredential
Inherited from
isRevoked()
isRevoked():
boolean
Defined in: packages/shared/domain/build/index.d.ts:342
Returns
boolean
Inherited from
isStorable()
isStorable():
this is StorableCredential
Defined in: packages/shared/domain/build/index.d.ts:341
Returns
this is StorableCredential
Inherited from
presentation()
presentation():
W3CVerifiablePresentation
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:427
Returns
Implementation of
ProvableCredential.presentation
toStorable()
toStorable(): {
availableClaims:string[];credentialData:string;id:any;issuer:string;recoveryId:string;revoked:boolean|undefined;subject:any;validUntil:any; }
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:458
Returns
{ availableClaims: string[]; credentialData: string; id: any; issuer: string; recoveryId: string; revoked: boolean | undefined; subject: any; validUntil: any; }
| Name | Type | Default value | Defined in |
|---|---|---|---|
availableClaims | string[] | claims | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:469 |
credentialData | string | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:465 |
id | any | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:463 |
issuer | string | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:466 |
recoveryId | string | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:464 |
revoked | boolean | undefined | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:470 |
subject | any | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:467 |
validUntil | any | - | packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:468 |
Implementation of
verifiableCredential()
verifiableCredential():
W3CVerifiableCredential
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:444
Returns
Implementation of
ProvableCredential.verifiableCredential
fromJWS()
staticfromJWS(jws:string,revoked?:boolean):JWTCredential
Defined in: packages/lib/sdk/src/pollux/models/JWTVerifiableCredential.ts:245
Parameters
| Parameter | Type |
|---|---|
jws | string |
revoked? | boolean |
Returns
JWTCredential