Skip to main content

JWT

@hyperledger/identus-sdk v8.1.3

@hyperledger/identus-sdk / overview / JWT

Class: JWT

Defined in: packages/lib/sdk/src/pollux/utils/jwt/JWT.ts:11

Extends​

  • Runner

Constructors​

Constructor​

new JWT(): JWT

Returns​

JWT

Inherited from​

Task.Runner.constructor

Methods​

clone()​

clone(): JWT

Defined in: packages/lib/sdk/src/pollux/utils/jwt/JWT.ts:12

Returns​

JWT

Overrides​

Task.Runner.clone

decode()​

decode(jws: string): Promise<DecodedObj>

Defined in: packages/lib/sdk/src/pollux/utils/jwt/JWT.ts:16

Parameters​

ParameterType
jwsstring

Returns​

Promise<DecodedObj>

signWithDID()​

signWithDID(did: DID, payload: Partial<Payload>, header?: Partial<Header>, privateKey?: PrivateKey, purpose?: "ISSUING_KEY" | "AUTHENTICATION_KEY"): Promise<string>

Defined in: packages/lib/sdk/src/pollux/utils/jwt/JWT.ts:30

Creates a signed JWT from a DID and Key

Parameters​

ParameterTypeDescription
didDID-
payloadPartial<Payload>-
header?Partial<Header>-
privateKey?PrivateKey-
purpose?"ISSUING_KEY" | "AUTHENTICATION_KEY"which verification relationship to use for key lookup (default: "assertionMethod")

Returns​

Promise<string>

verify()​

verify(options: { holderDID?: DID; issuerDID: DID; jws: string; }): Promise<boolean>

Defined in: packages/lib/sdk/src/pollux/utils/jwt/JWT.ts:40

Parameters​

ParameterType
options{ holderDID?: DID; issuerDID: DID; jws: string; }
options.holderDID?DID
options.issuerDIDDID
options.jwsstring

Returns​

Promise<boolean>

withContext()​

withContext(ctx: ContextProxy): Runner

Defined in: packages/lib/sdk/src/utils/tasks.ts:108

Parameters​

ParameterType
ctxContextProxy

Returns​

Runner

Inherited from​

Task.Runner.withContext