Feedback Edit

JSONWebKey Class

  • Reference

JSONWebKey.

All required parameters must be populated in order to send to Azure.

Inheritance
Model
JSONWebKey

Constructor

JSONWebKey(*, alg: str, kid: str, kty: str, use: str, crv: Optional[str] = None, d: Optional[str] = None, dp: Optional[str] = None, dq: Optional[str] = None, e: Optional[str] = None, k: Optional[str] = None, n: Optional[str] = None, p: Optional[str] = None, q: Optional[str] = None, qi: Optional[str] = None, x: Optional[str] = None, x5_c: Optional[List[str]] = None, y: Optional[str] = None, **kwargs)

Parameters

alg
str
Required

Required. The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name.

crv
str
Required

The "crv" (curve) parameter identifies the curve type.

d
str
Required

RSA private exponent or ECC private key.

dp
str
Required

RSA Private Key Parameter.

dq
str
Required

RSA Private Key Parameter.

e
str
Required

RSA public exponent, in Base64.

k
str
Required

Symmetric key.

kid
str
Required

Required. The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string.

kty
str
Required

Required. The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string.

n
str
Required

RSA modulus, in Base64.

p
str
Required

RSA secret prime.

q
str
Required

RSA secret prime, with p < q.

qi
str
Required

RSA Private Key Parameter.

use
str
Required

Required. Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption).

x
str
Required

X coordinate for the Elliptic Curve point.

x5_c
list[str]
Required

The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] – not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate.

y
str
Required

Y coordinate for the Elliptic Curve point.