dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-25 04:51:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jose/docs/interfaces/types.flattenedjws.md
Filip Skokan fb590bf66f chore: publish updated docs
2021-04-01 13:38:52 +02:00

1.8 KiB
Raw Blame History

Interface: FlattenedJWS

types.FlattenedJWS

Flattened JWS definition. Payload is an optional return property, it is not returned when JWS Unencoded Payload Option RFC7797 is used.

Hierarchy

Table of contents

Properties

Properties

header

• Optional header: JWSHeaderParameters

The "header" member MUST be present and contain the value JWS Unprotected Header when the JWS Unprotected Header value is non- empty; otherwise, it MUST be absent. This value is represented as an unencoded JSON object, rather than as a string. These Header Parameter values are not integrity protected.

Inherited from: void

Defined in: types.d.ts:163

payload

• Optional payload: string

Overrides: void

Defined in: types.d.ts:213

protected

• Optional protected: string

The "protected" member MUST be present and contain the value BASE64URL(UTF8(JWS Protected Header)) when the JWS Protected Header value is non-empty; otherwise, it MUST be absent. These Header Parameter values are integrity protected.

Inherited from: void

Defined in: types.d.ts:178

signature

• signature: string

Overrides: void

Defined in: types.d.ts:214