jose/docs/interfaces/types.jweheaderparameters.md

Interface: JWEHeaderParameters

types.JWEHeaderParameters

Recognized JWE Header Parameters, any other Header members may also be present.

Hierarchy

• JoseHeaderParameters

  ↳ JWEHeaderParameters

Indexable

▪ [propName: string]: unknown

Any other JWE Header member.

Table of contents

Properties

• alg
• crit
• cty
• enc
• jwk
• kid
• typ
• x5c
• x5t
• x5u
• zip

Properties

alg

• Optional alg: string

JWE "alg" (Algorithm) Header Parameter.

Defined in: types.d.ts:384

---

crit

• Optional crit: string[]

JWE "crit" (Critical) Header Parameter.

Defined in: types.d.ts:394

---

cty

• Optional cty: string

"cty" (Content Type) Header Parameter.

Inherited from: JoseHeaderParameters.cty

Defined in: types.d.ts:261

---

enc

• Optional enc: string

JWE "enc" (Encryption Algorithm) Header Parameter.

Defined in: types.d.ts:389

---

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:251

---

kid

• Optional kid: string

"kid" (Key ID) Header Parameter.

Inherited from: JoseHeaderParameters.kid

Defined in: types.d.ts:231

---

typ

• Optional typ: string

"typ" (Type) Header Parameter.

Inherited from: JoseHeaderParameters.typ

Defined in: types.d.ts:256

---

x5c

• Optional x5c: string[]

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

Inherited from: JoseHeaderParameters.x5c

Defined in: types.d.ts:241

---

x5t

• Optional x5t: string

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

Inherited from: JoseHeaderParameters.x5t

Defined in: types.d.ts:236

---

x5u

• Optional x5u: string

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

Inherited from: JoseHeaderParameters.x5u

Defined in: types.d.ts:246

---

zip

• Optional zip: string

JWE "zip" (Compression Algorithm) Header Parameter.

Defined in: types.d.ts:399