JsonWebTokenClaim

class oci.apigateway.models.JsonWebTokenClaim(**kwargs)

Bases: object

An individual JWT claim.

Methods

__init__(**kwargs) Initializes a new JsonWebTokenClaim object with values from keyword arguments.

Attributes

is_required Gets the is_required of this JsonWebTokenClaim.
key [Required] Gets the key of this JsonWebTokenClaim.
values Gets the values of this JsonWebTokenClaim.
__init__(**kwargs)

Initializes a new JsonWebTokenClaim object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • key (str) – The value to assign to the key property of this JsonWebTokenClaim.
  • values (list[str]) – The value to assign to the values property of this JsonWebTokenClaim.
  • is_required (bool) – The value to assign to the is_required property of this JsonWebTokenClaim.
is_required

Gets the is_required of this JsonWebTokenClaim. Whether the claim is required to be present in the JWT or not. If set to “false”, the claim values will be matched only if the claim is present in the JWT.

Returns:The is_required of this JsonWebTokenClaim.
Return type:bool
key

[Required] Gets the key of this JsonWebTokenClaim. Name of the claim.

Returns:The key of this JsonWebTokenClaim.
Return type:str
values

Gets the values of this JsonWebTokenClaim. The list of acceptable values for a given claim. If this value is “null” or empty and “isRequired” set to “true”, then the presence of this claim in the JWT is validated.

Returns:The values of this JsonWebTokenClaim.
Return type:list[str]