Sprache

CredentialDescription Klasse

Definition

Beschreibung einer Anmeldeinformation. Anmeldeinformationen werden verwendet, um die Identität der Anwendung zu beweisen (siehe ClientCredentials), oder um Token zu entschlüsseln (siehe TokenDecryptionCredentials). Anmeldeinformationen können geheime Schlüssel (geheime Clientschlüssel), Zertifikate oder signierte Assertionen sein. Sie können auf vielfältige Weise gespeichert oder bereitgestellt werden, und diese Klasse bietet eine Möglichkeit, sie zu beschreiben. Die Beschreibung wird dann von Microsoft verwendet. Identity.Web zum Abrufen der Anmeldeinformationen. (Siehe die DefaultCredentialProvider-Klasse)

public class CredentialDescription
type CredentialDescription = class
Public Class CredentialDescription
Vererbung
CredentialDescription
Abgeleitet

Konstruktoren

Name Beschreibung
CredentialDescription()

Der Standardkonstruktor.

CredentialDescription(CredentialDescription)

Kopieren des Konstruktors für CredentialDescription

Eigenschaften

Name Beschreibung
Algorithm

Algorithmus, der zum Erstellen von Signaturanmeldeinformationen verwendet wird.

Base64EncodedValue

Gibt in diesem SourceType Wert Base64Encodedden base64-codierten Wert des Zertifikats an.

CachedValue

Wenn die Anmeldeinformationen von einer ICredentialsLoaderabgerufen werden, wird sie in dieser Eigenschaft gespeichert, wo Sie sie abrufen können. Wenn es sich bei den Anmeldeinformationen um ein Zertifikat handelt, wird sie auch in der Certificate Eigenschaft gespeichert.

Certificate

In diesem Fall SourceTypeCertificateverwenden Sie diese Eigenschaft, um das Zertifikat selbst bereitzustellen. Wenn das Zertifikat oder oder StoreWithDistinguishedNameStoreWithThumbprint nachdem das Zertifikat von einem ICredentialsLoaderabgerufen wurde, wird es in dieser Eigenschaft und auch in der CachedValue.SourceTypeBase64EncodedKeyVaultPath

CertificateDiskPath

Gibt in diesem SourceType Beispiel Pathden Pfad zum Zertifikat auf dem Datenträger an. Mit dieser Eigenschaft können Sie den Pfad zu einer PFX-Datei angeben, die das Zertifikat und den privaten Schlüssel enthält. Wenn ein Kennwort erforderlich ist, verwenden Sie CertificatePassword.

CertificateDistinguishedName

Wenn SourceType der Wert ist StoreWithDistinguishedName, gibt den distinguished Name des Zertifikats im durch CertificateStorePath.

CertificatePassword

Gibt in diesem SourceType Wert Pathdas Kennwort an, das für den Zugriff auf das Zertifikat verwendet werden soll, durch CertificateDiskPathdas der Pfad angegeben wird. Verwenden Sie diese Eigenschaft nur, wenn das Zertifikat durch ein Kennwort geschützt ist.

CertificateStorePath

Wenn SourceType oder StoreWithDistinguishedNameStoreWithThumbprintStoreWithSubjectName, gibt den Zertifikatspeicher an, aus dem das Zertifikat extrahiert werden soll. Das Format ist die Verkettung eines Werts und StoreLocation eines Werts, der StoreName durch einen Schrägstrich getrennt ist. Verwenden Sie CurrentUser/My beispielsweise für ein Benutzerzertifikat und LocalMachine/My für ein Computerzertifikat.

CertificateSubjectName

Gibt SourceType den StoreWithSubjectNameAntragstellernamen des Zertifikats in dem durch CertificateStorePath.

CertificateThumbprint

Wenn SourceType der Fingerabdruck des Zertifikats angegeben ist StoreWithThumbprint , das aus dem zertifikatsspeicher extrahiert werden soll, der durch CertificateStorePath.

ClientSecret

In diesem Beispiel SourceType wird ClientSecretder geheime Clientschlüssel beschrieben, der als Clientanmeldeinformationen in einer vertraulichen Clientanwendung verwendet werden soll. Der geheime Clientschlüssel ist eine Zeichenfolge, die nur der Anwendung und dem Identitätsanbieter bekannt ist. Er muss mit dem wert übereinstimmen, der während der Anwendungsregistrierung konfiguriert ist.

CredentialType

Beschreibt den Typ der Anmeldeinformationen basierend auf dem SourceType.

CustomSignedAssertionProviderData

Dehnbarkeit. Bei Verwendung mit SourceType = CustomSignedAssertiondieser Eigenschaft werden zusätzliche Daten angegeben, die an die Erweiterung übergeben werden, die die signierte Assertion verarbeitet. Dies ist für SDKs gedacht, die die Beschreibungsfunktionen für Anmeldeinformationen erweitern.

CustomSignedAssertionProviderName

Dehnbarkeit. Bei Verwendung mit SourceType = CustomSignedAssertiondieser Eigenschaft wird der vollqualifizierte Name der Erweiterung angegeben, mit der die signierte Assertion abgerufen wird, die als Clientanmeldeinformationen verwendet wird.

DecryptKeysAuthenticationOptions

In diesem Fall SourceTypeAutoDecryptKeysbeschreibt diese Eigenschaft die Autorität zum Abrufen eines Tokens für eine Web-API, um die Schlüssel abzurufen, die zum Entschlüsseln eines verschlüsselten Tokens verwendet werden. Die Cloudinstanz ist identisch mit der Anwendung, aber die Anwendung kann eine mehrinstanzenfähige Anwendung (Mandant = häufig oder Organisationen) sein, und in diesem Fall muss der Anmeldeinformationstyp einen Mandanten bereitstellen, um ein Token im Namen von sich selbst abzurufen. Im Allgemeinen möchten Sie möglicherweise Authentifizierungsoptionen angeben, einschließlich Protokoll, PopKey usw. Diese Beschreibung der Anmeldeinformationen wird nur zum Entschlüsseln von Anmeldeinformationen und nicht für Clientanmeldeinformationen verwendet.

Id

Ruft einen eindeutigen Bezeichner für eine CredentialDescription basierend auf SourceType.

KeyVaultCertificateName

Verwenden SourceType Sie in diesem Fall KeyVaultdiese Eigenschaft, um den Namen des Zertifikats in Key Vault in Verbindung mit KeyVaultUrl.

KeyVaultUrl

Verwenden SourceType Sie in diesem Fall KeyVaultdiese Eigenschaft, um die URL der Key Vault anzugeben, die das Zertifikat enthält, in Verbindung mit KeyVaultCertificateName.

ManagedIdentityClientId

Wenn SourceType dies der Wert istSignedAssertionFromManagedIdentity, gibt sie die Client-ID der Azure vom Benutzer zugewiesenen verwalteten Identität an, die verwendet wird, um eine signierte Assertion bereitzustellen, die als Clientanmeldeinformationen für die Anwendung fungiert. Dies erfordert, dass die Anwendung auf Azure bereitgestellt wird, dass die verwaltete Identität konfiguriert ist und dass der Arbeitsauslastungsidentitätsverbund mit der verwalteten Identität in der Anwendungsregistrierung deklariert wird. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/active-directory/workload-identities/workload-identity-federation.

SignedAssertionFileDiskPath

SignedAssertionFilePathGibt SourceType optional den Pfad auf dem Datenträger einer Datei an, die eine signierte Assertion enthält, die als Client assertion für die vertrauliche Clientanwendung verwendet wird. Die signierte Assertionsdatei ist eine Datei mit einer signierten JWT-Assertion, die als Clientanmeldeinformationen verwendet wird. In der Regel verwenden Sie diese Option, wenn Sie den Workload-Identitätsverbund mit Azure Kubernetes Service (AKS) integrieren möchten. Weitere Informationen finden Sie unter https://learn.microsoft.com/azure/active-directory/workload-identities/workload-identity-federation.

Skip

Überspringen Sie diese Beschreibung der Anmeldeinformationen. Dies ist nützlich, wenn Sie eine Liste der Anmeldeinformationen angeben, von denen einige nicht in einer bestimmten Bereitstellung gelten. Sie wird auch verwendet, ICredentialsLoader wenn sie die Anmeldeinformationen nicht finden oder laden kann.

SourceType

Typ der Quelle der Anmeldeinformationen. Diese Eigenschaft wird verwendet, um zu bestimmen, welche anderen Eigenschaften bereitgestellt werden müssen, um die Anmeldeinformationen zu beschreiben.

TokenExchangeAuthority

Gibt in diesem SourceType Beispiel SignedAssertionFromManagedIdentitydie Autoritäts-URL an, die für den Tokenaustausch verwendet werden soll. Dies ist in Szenarien hilfreich, in denen sich der Aussteller für den Tokenaustausch von der Autorität der Anwendung unterscheidet.

TokenExchangeUrl

(Microsoft Entra spezifischen) Wert, der zum Konfigurieren der Tokenaustauschressourcen-URL im Fall von Verbundidentitätsanmeldeinformationen mit verwalteter Identität verwendet werden kann.

UseBoundCredential

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob diese Anmeldeinformationen als gebundene Anmeldeinformationen (mTLS gebunden) verwendet werden sollen, wenn sie von der Hostbibliothek unterstützt werden. Quellen mit Zertifikatsgeschmack (Certificate, , KeyVault, PathBase64Encoded, StoreWithThumbprint, , StoreWithSubjectNameStoreWithDistinguishedNameund ManagedCertificate) werden SignedAssertionFromManagedIdentity erwartet, dass diese Einstellung berücksichtigt wird. Es wird erwartet, dass andere Quelltypen diese Einstellung basierend auf der Auswahl der Hostbibliothek ignorieren. Der Standardwert ist false, wodurch das vorhandene Verhalten beibehalten wird. Weitere Informationen finden Sie unter MSAL.NET Problem 5791.

Gilt für: