InteractiveBrowserCredential Klasse

Öffnet einen Browser, um einen Benutzer interaktiv zu authentifizieren.

get_token öffnet einen Browser mit einer von Azure Active Directory bereitgestellten Anmelde-URL und authentifiziert dort einen Benutzer mit dem Autorisierungscodeflow, wobei PKCE (Proof Key for Code Exchange) intern verwendet wird, um den Code zu schützen.

Vererbung

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

Konstruktor

InteractiveBrowserCredential(**kwargs: Any)

Parameter

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.

tenant_id

str

eine Azure Active Directory-Mandanten-ID. Standardmäßig wird der Mandant "organizations" verwendet, der Geschäfts-, Schul- oder Unikonten authentifizieren kann.

client_id

str

Die Client-ID der Benutzer der Azure Active Directory-Anwendung wird bei angemeldet. Wenn keine Angabe erfolgt, authentifizieren sich Die Benutzer bei einer Azure-Entwicklungsanwendung.

login_hint

str

Ein Benutzernamesvorschlag, um das Feld benutzername/E-Mail-Adresse der Anmeldeseite vorab auszufüllen. Ein Benutzer kann sich weiterhin mit einem anderen Benutzernamen anmelden.

redirect_uri

str

ein Umleitungs-URI für die Anwendung , die von client_id wie in Azure Active Directory konfiguriert, z. B. "http://localhost:8400". Dies ist nur erforderlich, wenn ein Wert für client_id übergeben wird, und muss mit einem Umleitungs-URI in der Registrierung der Anwendung übereinstimmen. Die Anmeldeinformationen müssen in der Lage sein, einen Socket an diesen URI zu binden.

authentication_record

AuthenticationRecord

AuthenticationRecord zurückgegeben von authenticate

disable_automatic_authentication

bool

wenn True, wird ausgelöstAuthenticationRequiredError, get_token wenn eine Benutzerinteraktion erforderlich ist, um ein Token abzurufen. Der Standardwert lautet „False“.

cache_persistence_options

TokenCachePersistenceOptions

Konfiguration für die persistente Tokenzwischenspeicherung. Wenn sie nicht angegeben sind, werden die Anmeldeinformationen Token im Arbeitsspeicher zwischenspeichern.

timeout

int

Sekunden warten, bis der Benutzer die Authentifizierung abgeschlossen hat. Der Standardwert ist 300 (5 Minuten).

disable_instance_discovery

bool

Bestimmt, ob instance Ermittlung ausgeführt wird, wenn versucht wird, sich zu authentifizieren. Wenn Sie dies auf true festlegen, werden sowohl instance Ermittlung als auch die Validierung von Autoritäten vollständig deaktiviert. Diese Funktionalität ist für die Verwendung in Szenarien vorgesehen, in denen der Metadatenendpunkt nicht erreicht werden kann, z. B. in privaten Clouds oder Azure Stack. Der Prozess der instance Ermittlung umfasst das Abrufen von Autoritätsmetadaten aus, https://login.microsoft.com/ um die Autorität zu überprüfen. Wenn Sie dies auf True festlegen, wird die Überprüfung der Autorität deaktiviert. Daher ist es wichtig sicherzustellen, dass der konfigurierte Autoritätshost gültig und vertrauenswürdig ist.

Beispiele

Erstellen Sie ein InteractiveBrowserCredential-Objekt.

   from azure.identity import InteractiveBrowserCredential

   credential = InteractiveBrowserCredential(
       client_id="<client_id>",
   )

Methoden

authenticate	Interaktive authentifizierung eines Benutzers.
close
get_token	Fordern Sie ein Zugriffstoken für Bereiche an. Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.

authenticate

Interaktive authentifizierung eines Benutzers.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parameter

scopes

Iterable[str]

Bereiche, die während der Authentifizierung angefordert werden sollen, z. B. die von bereitgestellten scopes. Falls angegeben, speichert die erfolgreiche Authentifizierung ein Zugriffstoken für diese Bereiche zwischen.

claims

str

zusätzliche Ansprüche, die im Token erforderlich sind, z. B. die von claims

Rückgabetyp

AuthenticationRecord

Ausnahmen

ClientAuthenticationError

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

close

close() -> None

Ausnahmen

ClientAuthenticationError

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

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. solche, 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.

AuthenticationRequiredError

Benutzerinteraktionen sind erforderlich, um ein Token abzurufen, und die Anmeldeinformationen sind so konfiguriert, dass sie nicht automatisch beginnen. Aufruf

authenticate

, um mit der interaktiven Authentifizierung zu beginnen.