Share via


JsonWebKey Class

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api10.JsonWebKeyTypeConverter))]
public class JsonWebKey : Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api10.IJsonWebKey
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api10.JsonWebKeyTypeConverter))>]
type JsonWebKey = class
    interface IJsonWebKey
    interface IJsonSerializable
Public Class JsonWebKey
Implements IJsonWebKey
Inheritance
JsonWebKey
Attributes
Implements

Constructors

JsonWebKey()

Creates an new JsonWebKey instance.

Properties

Alg

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

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

D

RSA private exponent or ECC private key

Dp

RSA Private Key Parameter

Dq

RSA Private Key Parameter

E

RSA public exponent, in Base64

K

Symmetric key

Kid

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

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

RSA modulus, in Base64

P

RSA secret prime

Q
Qi

RSA Private Key Parameter

Use

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

X coordinate for the Elliptic Curve point

X5C

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

Y coordinate for the Elliptic Curve point

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of JsonWebKey.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of JsonWebKey.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Attestation.Models.Api10.IJsonWebKey.

FromJsonString(String)

Creates a new instance of JsonWebKey, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of JsonWebKey into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to