on_header_param Event

Fires once for each JOSE header parameter.

Syntax

class JWSHeaderParamEventParams(object):
  @property
  def name() -> str: ...
  @property
  def value() -> str: ...
  @property
  def data_type() -> int: ...

# In class JWS:
@property
def on_header_param() -> Callable[[JWSHeaderParamEventParams], None]: ...
@on_header_param.setter
def on_header_param(event_hook: Callable[[JWSHeaderParamEventParams], None]) -> None: ...

Remarks

When verify or parse is called this event will fire once for each JOSE header parameter.

Name is the name of the parameter.

Value is the value of the parameter.

DataType specifies the JSON data type of the value. Possible values are:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)