Freigeben über

ClientAssertionCredential Klasse

  • Referenz

Authentifiziert einen Dienstprinzipal mit einer JWT-Assertion.

Diese Anmeldeinformationen sind für erweiterte Szenarien vorgesehen. CertificateCredential verfügt über eine bequemere API für das häufigste Assertionsszenario, die Authentifizierung eines Dienstprinzipals mit einem Zertifikat.

Vererbung
azure.identity._internal.get_token_mixin.GetTokenMixin
ClientAssertionCredential

Konstruktor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

Parameter

tenant_id
str
Erforderlich

ID des Mandanten des Prinzipals. Wird auch als "Verzeichnis"-ID bezeichnet.

client_id
str
Erforderlich

Die Client-ID des Prinzipals

func
Erforderlich

Ein aufrufbarer , der eine Zeichenfolgenassertion zurückgibt. Die Anmeldeinformationen rufen diese bei jedem Abrufen eines neuen Tokens auf.

authority
str

Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für die öffentliche Azure-Cloud (standard). AzureAuthorityHosts definiert Autoritäten für andere Clouds.

additionally_allowed_tenants
List[str]

Gibt Mandanten zusätzlich zum angegebenen "tenant_id" an, für den die Anmeldeinformationen Token abrufen können. Fügen Sie den Wildcardwert "*" hinzu, damit die Anmeldeinformationen Token für jeden Mandanten abrufen können, auf den die Anwendung zugreifen kann.

Beispiele

Erstellen Sie clientAssertionCredential.


   from azure.identity import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

Methoden

close
get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

close 

close() -> None

get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parameter

scopes
str
Erforderlich

gewünschte Bereiche für das Zugriffstoken. Für diese Methode ist mindestens ein Bereich erforderlich. Weitere Informationen zu Bereichen finden Sie unter https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

Zusätzliche Ansprüche, die im Token erforderlich sind, z. B. die in der Anspruchsanforderung eines Ressourcenanbieters nach einem Autorisierungsfehler zurückgegeben werden.

tenant_id
str

optionaler Mandant, der in die Tokenanforderung aufgenommen werden soll.

enable_cae
bool

gibt an, ob die fortlaufende Zugriffsauswertung (Continuous Access Evaluation, CAE) für das angeforderte Token aktiviert werden soll. Der Standardwert lautet „False“.

Gibt zurück

Ein Zugriffstoken mit den gewünschten Bereichen.

Rückgabetyp

AccessToken

Ausnahmen

CredentialUnavailableError

Die Anmeldeinformationen können nicht versucht werden, die Authentifizierung zu versuchen, da die erforderlichen Daten, der Status oder die Plattform nicht unterstützt werden.

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an.