AuthorizationCodeCredential Klasse

Authentifiziert sich, indem ein Autorisierungscode eingelöst wird, der zuvor von Azure Active Directory abgerufen wurde.

Weitere Informationen zum Authentifizierungsablauf finden Sie in der Dokumentation zu Azure Active Directory .

Vererbung

azure.identity.aio._internal.AsyncContextManager

AuthorizationCodeCredential

azure.identity.aio._internal.get_token_mixin.GetTokenMixin

AuthorizationCodeCredential

Konstruktor

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, *, client_secret: str | None = None, **kwargs)

Parameter

tenant_id

str

Erforderlich

ID des Azure Active Directory-Mandanten der Anwendung. Wird auch als "Verzeichnis"-ID bezeichnet.

client_id

str

Erforderlich

Die Client-ID der Anwendung

authorization_code

str

Erforderlich

Der Autorisierungscode aus der Benutzeranmeldung

redirect_uri

str

Erforderlich

Der Umleitungs-URI der Anwendung. Muss mit dem URI übereinstimmen, der zum Anfordern des Autorisierungscodes verwendet wird.

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.

client_secret

str

Eines der Clientgeheimnisse der Anwendung. Nur für Web-Apps und Web-APIs erforderlich.

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 ein AuthorizationCodeCredential-Objekt.

   from azure.identity.aio import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

Methoden

close

Schließen Sie die Transportsitzung der Anmeldeinformationen.

get_token

Fordern Sie ein Zugriffstoken für Bereiche an. Diese Methode wird von Azure SDK-Clients automatisch aufgerufen. Wenn diese Methode zum ersten Mal aufgerufen wird, lösen die Anmeldeinformationen ihren Autorisierungscode ein. Bei nachfolgenden Aufrufen geben die Anmeldeinformationen ein zwischengespeichertes Zugriffstoken zurück oder lösen ein Aktualisierungstoken ein, wenn beim Einlösen des Autorisierungscodes ein Aktualisierungstoken abgerufen wurde.

close

Schließen Sie die Transportsitzung der Anmeldeinformationen.

async close()

get_token

Fordern Sie ein Zugriffstoken für Bereiche an.

Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

Wenn diese Methode zum ersten Mal aufgerufen wird, lösen die Anmeldeinformationen ihren Autorisierungscode ein. Bei nachfolgenden Aufrufen geben die Anmeldeinformationen ein zwischengespeichertes Zugriffstoken zurück oder lösen ein Aktualisierungstoken ein, wenn beim Einlösen des Autorisierungscodes ein Aktualisierungstoken abgerufen wurde.

async 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.

Gibt zurück

Ein Zugriffstoken mit den gewünschten Bereichen.

Rückgabetyp

AccessToken

Ausnahmen

ClientAuthenticationError

Fehler bei der Authentifizierung. Das Attribut des Fehlers message gibt einen Grund an. Alle Fehlerantworten von Azure Active Directory sind als Attribut des Fehlers response verfügbar.