Interface JoseHeaderParams

JSON Object Signing and Encryption (JOSE) Header Parameters

The Header Parameter names for use in both JWSs and JWEs are registered in the IANA "JSON Web Signature and Encryption Header Parameters" registry.

As indicated by the common registry, JWSs and JWEs share a common Header Parameter space; when a parameter is used by both specifications, its usage must be compatible between the specifications.

See

RFC 7515, Section 4.1

interface JoseHeaderParams {
    cty?: string;
    jku?: string;
    jwk?: Jwk;
    kid?: string;
    typ?: string;
    x5c?: string[];
    x5t?: string;
    x5u?: string;
}

Hierarchy (view full)

Properties

cty? jku? jwk? kid? typ? x5c? x5t? x5u?

Properties

Optional cty

cty?: string

Content Type Header Parameter

Optional jku

jku?: string

JWK Set URL Header Parameter

Optional jwk

jwk?: Jwk

JSON Web Key Header Parameter

Optional kid

kid?: string

Key ID Header Parameter

Optional typ

typ?: string

Type Header Parameter

Optional x5c

x5c?: string[]

X.509 Certificate Chain Header Parameter

Optional x5t

x5t?: string

X.509 Certificate SHA-1 Thumbprint Header Parameter

Optional x5u

x5u?: string

X.509 URL Header Parameter

Settings

Member Visibility

Theme

On This Page

ctyjkujwkkidtypx5cx5tx5u