CertificateOptions Class

Definition

Namespace:
Microsoft.Identity.Client.AppConfig
Assembly:
Microsoft.Identity.Client.dll
Package:
Microsoft.Identity.Client v4.84.2

Represents configuration options for certificate handling or management.

public class CertificateOptions : IEquatable<Microsoft.Identity.Client.AppConfig.CertificateOptions>
type CertificateOptions = class
    interface IEquatable<CertificateOptions>
Public Class CertificateOptions
Implements IEquatable(Of CertificateOptions)
Inheritance
Object
CertificateOptions
Implements
IEquatable<CertificateOptions>

Constructors

Name Description
CertificateOptions()
CertificateOptions(CertificateOptions)

Properties

Name Description
AssociateTokensWithCertificate

Gets or sets a value indicating if the application tokens acquired from Azure AD are associated with the certificate serial number. This property when set, allow you to associate the tokens acquired from Azure AD with the certificate serial number. This can be used to partition the cache by certificate. Tokens acquired with one certificate will not be accessible to another certificate with a different serial number. <remarks>Set this property to true to indicate that the tokens acquired from Azure AD are associated with the certificate serial number, by default it is set to false /></remarks>
EqualityContract
SendCertificateOverMtls

Gets or sets a value indicating whether the certificate should be sent over mTLS (TLS client certificate authentication) as the default transport for token requests. When true, the certificate is sent in the TLS handshake instead of as a JWT assertion in the request body. This controls transport only — the resulting token type depends on request-level configuration: a plain request produces a Bearer token, while WithMtlsProofOfPossession() produces an mTLS PoP token. When false (default), the certificate is sent as a JWT assertion in the request body.
SendX5C

Gets or sets a value indicating whether the X.509 certificate chain (x5c) should be included in the token request.

Methods

Name Description
<Clone>$()
Equals(CertificateOptions)
Equals(Object)
GetHashCode()
PrintMembers(StringBuilder)
ToString()

Operators

Name Description
Equality(CertificateOptions, CertificateOptions)
Inequality(CertificateOptions, CertificateOptions)

Applies to