#### [Abblix\.Jwt](https://www.abblix.com/en/docs/api/abblix-jwt 'index')
### [Abblix\.Jwt](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt 'Abblix\.Jwt')

## JsonWebKey Class

Base class representing a JSON Web Key \(JWK\), a versatile structure for representing cryptographic keys using JSON\.
JWKs are crucial for digital signatures, encryption, and ensuring secure communication in web\-based protocols\.

```csharp
public abstract record JsonWebKey : System.IEquatable<Abblix.Jwt.JsonWebKey>
```

Inheritance [System\.Object](https://learn.microsoft.com/en-us/dotnet/api/system.object 'System\.Object') → JsonWebKey

Derived  
↳ [EllipticCurveJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.EllipticCurveJsonWebKey 'Abblix\.Jwt\.EllipticCurveJsonWebKey')  
↳ [OctetJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.OctetJsonWebKey 'Abblix\.Jwt\.OctetJsonWebKey')  
↳ [RsaJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.RsaJsonWebKey 'Abblix\.Jwt\.RsaJsonWebKey')

Implements [System\.IEquatable&lt;](https://learn.microsoft.com/en-us/dotnet/api/system.iequatable-1 'System\.IEquatable\`1')[JsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.JsonWebKey 'Abblix\.Jwt\.JsonWebKey')[&gt;](https://learn.microsoft.com/en-us/dotnet/api/system.iequatable-1 'System\.IEquatable\`1')

### Remarks
This is an abstract base class\. Use specific subclasses for different key types:
- [RsaJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.RsaJsonWebKey 'Abblix\.Jwt\.RsaJsonWebKey') for RSA keys
- [EllipticCurveJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.EllipticCurveJsonWebKey 'Abblix\.Jwt\.EllipticCurveJsonWebKey') for Elliptic Curve keys
- [OctetJsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.OctetJsonWebKey 'Abblix\.Jwt\.OctetJsonWebKey') for symmetric keys (oct)
### Properties

## JsonWebKey\.Algorithm Property {#Abblix.Jwt.JsonWebKey.Algorithm}

Specifies the algorithm intended for use with the key, aligning with JWT and JWA specifications
to ensure interoperability and secure key management\.

```csharp
public string? Algorithm { get; set; }
```

#### Property Value
[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')

## JsonWebKey\.Certificates Property {#Abblix.Jwt.JsonWebKey.Certificates}

Contains a chain of one or more PKIX certificates \(RFC 5280\), offering a method to associate X\.509
certificates with the key for validation and trust chain establishment in secure communications\.

```csharp
public byte[][]? Certificates { get; set; }
```

#### Property Value
[System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array')

## JsonWebKey\.HasPrivateKey Property {#Abblix.Jwt.JsonWebKey.HasPrivateKey}

Checks if the key contains private key material\.

```csharp
public abstract bool HasPrivateKey { get; }
```

#### Property Value
[System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean')

## JsonWebKey\.HasPublicKey Property {#Abblix.Jwt.JsonWebKey.HasPublicKey}

Checks if the key contains public key material\.

```csharp
public abstract bool HasPublicKey { get; }
```

#### Property Value
[System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean')

## JsonWebKey\.KeyId Property {#Abblix.Jwt.JsonWebKey.KeyId}

A unique identifier for the key, facilitating key selection and management in multi\-key environments,
enabling clients and servers to reference and utilize the correct key for cryptographic operations\.

```csharp
public string? KeyId { get; set; }
```

#### Property Value
[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')

## JsonWebKey\.KeyType Property {#Abblix.Jwt.JsonWebKey.KeyType}

Identifies the cryptographic algorithm family used with the key, such as RSA, EC \(Elliptic Curve\), or oct \(Octet Sequence\),
specifying the key's type and its intended cryptographic use\.

```csharp
public abstract string KeyType { get; }
```

#### Property Value
[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')

### Remarks
This property is marked with [System\.Text\.Json\.Serialization\.JsonIgnoreAttribute](https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonignoreattribute 'System\.Text\.Json\.Serialization\.JsonIgnoreAttribute') on the base class to prevent conflicts
with the custom [JsonWebKeyConverter](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.JsonWebKeyConverter 'Abblix\.Jwt\.JsonWebKeyConverter')\. Derived types override this property with
`[JsonPropertyName("kty")]` and `[JsonInclude]` attributes\. The custom converter ensures
"kty" is always serialized by serializing the concrete type's properties, maintaining RFC 7517 compliance\.

## JsonWebKey\.Thumbprint Property {#Abblix.Jwt.JsonWebKey.Thumbprint}

A base64url\-encoded SHA\-1 thumbprint of the DER encoding of an X\.509 certificate, providing a compact
means to associate a certificate with the JWK for verification purposes without transmitting the full certificate\.

```csharp
public byte[]? Thumbprint { get; set; }
```

#### Property Value
[System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array')

## JsonWebKey\.Usage Property {#Abblix.Jwt.JsonWebKey.Usage}

Indicates the intended use of the key, for example, "sig" \(signature\) for signing operations or
"enc" \(encryption\) for encryption operations, guiding clients on how to use the key appropriately\.

```csharp
public string? Usage { get; set; }
```

#### Property Value
[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')
### Methods

## JsonWebKey\.ComputeJwkThumbprint\(\) Method {#Abblix.Jwt.JsonWebKey.ComputeJwkThumbprint()}

Computes the JWK Thumbprint of this key per RFC 7638 §3 as the raw 32\-byte SHA\-256
digest of the canonical\-JSON form built by [Abblix\.Jwt\.JsonWebKey\.CanonicalJson](https://learn.microsoft.com/en-us/dotnet/api/abblix.jwt.jsonwebkey.canonicaljson 'Abblix\.Jwt\.JsonWebKey\.CanonicalJson')\.

```csharp
public byte[] ComputeJwkThumbprint();
```

#### Returns
[System\.Byte](https://learn.microsoft.com/en-us/dotnet/api/system.byte 'System\.Byte')[\[\]](https://learn.microsoft.com/en-us/dotnet/api/system.array 'System\.Array')  
The 32\-byte SHA\-256 digest\.

#### Exceptions

[System\.InvalidOperationException](https://learn.microsoft.com/en-us/dotnet/api/system.invalidoperationexception 'System\.InvalidOperationException')  
A required member
            \(per RFC 7638 §3\.2\) is missing on this key\.

### Remarks
The thumbprint is computed at runtime from the public\-key material; it is not a
stored member on the JWK and is distinct from the X\.509 certificate thumbprints
`x5t` \(RFC 7517 §4\.8\) and `x5t#S256` \(RFC 7517 §4\.9\), which hash the
certificate, not the key\. OAuth 2\.0 DPoP \(RFC 9449\) uses this value for
`cnf.jkt` and the `dpop_jkt` request parameter\.

## JsonWebKey\.ComputeJwkThumbprintBase64Url\(\) Method {#Abblix.Jwt.JsonWebKey.ComputeJwkThumbprintBase64Url()}

Computes the JWK Thumbprint of this key per RFC 7638 §3 and returns the
base64url\-encoded form, which is the wire shape used by DPoP `cnf.jkt` and
the `dpop_jkt` authorization\-request parameter\.

```csharp
public string ComputeJwkThumbprintBase64Url();
```

#### Returns
[System\.String](https://learn.microsoft.com/en-us/dotnet/api/system.string 'System\.String')  
The base64url\-encoded SHA\-256 digest of the canonical\-JSON form\.

#### Exceptions

[System\.InvalidOperationException](https://learn.microsoft.com/en-us/dotnet/api/system.invalidoperationexception 'System\.InvalidOperationException')  
A required member
            \(per RFC 7638 §3\.2\) is missing on this key\.

## JsonWebKey\.Sanitize\(bool\) Method {#Abblix.Jwt.JsonWebKey.Sanitize(bool)}

Prepares a sanitized version of the JWK that excludes private key information unless explicitly included,
suitable for public sharing while preserving the integrity of sensitive data\.

```csharp
public abstract Abblix.Jwt.JsonWebKey Sanitize(bool includePrivateKeys);
```
#### Parameters

###### `includePrivateKeys` [System\.Boolean](https://learn.microsoft.com/en-us/dotnet/api/system.boolean 'System\.Boolean') {#Abblix.Jwt.JsonWebKey.Sanitize(bool).includePrivateKeys}

Whether to include private key data in the sanitized output\.

#### Returns
[JsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.JsonWebKey 'Abblix\.Jwt\.JsonWebKey')  
A new instance of [JsonWebKey](https://www.abblix.com/en/docs/api/abblix-jwt/Abblix.Jwt.JsonWebKey 'Abblix\.Jwt\.JsonWebKey') with or without private key data based on the input parameter\.