PemEncodedPublicKey

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

Bases: StaticPublicKey

A PEM-encoded public key used for verifying the JWT signature.

Attributes:

FORMAT_JSON_WEB_KEY

A constant which can be used with the format property of a StaticPublicKey.

FORMAT_PEM

A constant which can be used with the format property of a StaticPublicKey.

format

[Required] Gets the format of this StaticPublicKey.

key

[Required] Gets the key of this PemEncodedPublicKey.

kid

[Required] Gets the kid of this StaticPublicKey.

Methods:

__init__(**kwargs)

Initializes a new PemEncodedPublicKey object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

FORMAT_JSON_WEB_KEY = 'JSON_WEB_KEY'

A constant which can be used with the format property of a StaticPublicKey. This constant has a value of “JSON_WEB_KEY”

FORMAT_PEM = 'PEM'

A constant which can be used with the format property of a StaticPublicKey. This constant has a value of “PEM”

__init__(**kwargs)

Initializes a new PemEncodedPublicKey object with values from keyword arguments. The default value of the format attribute of this class is PEM and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • kid (str) – The value to assign to the kid property of this PemEncodedPublicKey.

  • format (str) – The value to assign to the format property of this PemEncodedPublicKey. Allowed values for this property are: “JSON_WEB_KEY”, “PEM”

  • key (str) – The value to assign to the key property of this PemEncodedPublicKey.

property format

[Required] Gets the format of this StaticPublicKey. The format of the public key.

Allowed values for this property are: “JSON_WEB_KEY”, “PEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The format of this StaticPublicKey.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property key

[Required] Gets the key of this PemEncodedPublicKey. The content of the PEM-encoded public key.

Returns

The key of this PemEncodedPublicKey.

Return type

str

property kid

[Required] Gets the kid of this StaticPublicKey. A unique key ID. This key will be used to verify the signature of a JWT with matching “kid”.

Returns

The kid of this StaticPublicKey.

Return type

str