jose/docs/interfaces/types.jwsheaderparameters.md
2021-03-15 17:21:54 +01:00

3.5 KiB

Interface: JWSHeaderParameters

types.JWSHeaderParameters

Recognized JWS Header Parameters, any other Header Members may also be present.

Hierarchy

Indexable

▪ [propName: string]: any

Any other JWS Header member.

Table of contents

Properties

Properties

alg

Optional alg: string

JWS "alg" (Algorithm) Header Parameter.

Defined in: types.d.ts:219


b64

Optional b64: boolean

This JWS Extension Header Parameter modifies the JWS Payload representation and the JWS Signing Input computation as per RFC7797.

Defined in: types.d.ts:226


crit

Optional crit: string[]

JWS "crit" (Critical) Header Parameter.

Defined in: types.d.ts:231


cty

Optional cty: string

"cty" (Content Type) Header Parameter.

Inherited from: JoseHeaderParameters.cty

Defined in: types.d.ts:208


jwk

Optional jwk: Pick<JWK, kty | crv | x | y | e | n>

"jwk" (JSON Web Key) Header Parameter.

Inherited from: JoseHeaderParameters.jwk

Defined in: types.d.ts:198


kid

Optional kid: string

"kid" (Key ID) Header Parameter.

Inherited from: JoseHeaderParameters.kid

Defined in: types.d.ts:178


typ

Optional typ: string

"typ" (Type) Header Parameter.

Inherited from: JoseHeaderParameters.typ

Defined in: types.d.ts:203


x5c

Optional x5c: string[]

"x5c" (X.509 Certificate Chain) Header Parameter.

Inherited from: JoseHeaderParameters.x5c

Defined in: types.d.ts:188


x5t

Optional x5t: string

"x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter.

Inherited from: JoseHeaderParameters.x5t

Defined in: types.d.ts:183


x5u

Optional x5u: string

"x5u" (X.509 URL) Header Parameter.

Inherited from: JoseHeaderParameters.x5u

Defined in: types.d.ts:193