InteractiveBrowserCredential Klass
Öppnar en webbläsare för att interaktivt autentisera en användare.
get_token öppnar en webbläsare till en inloggnings-URL som tillhandahålls av Azure Active Directory och autentiserar en användare där med auktoriseringskodflödet, med hjälp av PKCE (Proof Key for Code Exchange) internt för att skydda koden.
- Arv
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Konstruktor
InteractiveBrowserCredential(**kwargs: Any)
Parametrar
- authority
- str
Utfärdare av en Azure Active Directory-slutpunkt, till exempel "login.microsoftonline.com", utfärdaren för Azure Public Cloud (som är standard). AzureAuthorityHosts definierar myndigheter för andra moln.
- tenant_id
- str
ett Klient-ID för Azure Active Directory. Standardinställningen är klientorganisationen "organisationer", som kan autentisera arbets- eller skolkonton.
- client_id
- str
Klient-ID för Azure Active Directory-programanvändare loggar in på. Om det inte anges autentiseras användarna till ett Azure-utvecklingsprogram.
- login_hint
- str
ett användarnamnsförslag för att fylla i inloggningssidans användarnamn/e-postadressfält i förväg. En användare kan fortfarande logga in med ett annat användarnamn.
- redirect_uri
- str
en omdirigerings-URI för programmet som identifieras av client_id enligt konfigurationen i Azure Active Directory, till exempel "http://localhost:8400". Detta krävs endast när du skickar ett värde för client_id och måste matcha en omdirigerings-URI i programmets registrering. Autentiseringsuppgifterna måste kunna binda en socket till den här URI:n.
- authentication_record
- AuthenticationRecord
AuthenticationRecord returneras av authenticate
- disable_automatic_authentication
- bool
Om värdet är Sant get_token genereras AuthenticationRequiredError när användarinteraktion krävs för att hämta en token. Standardvärdet är False.
- cache_persistence_options
- TokenCachePersistenceOptions
konfiguration för beständig tokencachelagring. Om de inte anges cachelagrar autentiseringsuppgifterna token i minnet.
- timeout
- int
sekunder att vänta tills användaren har slutfört autentiseringen. Standardvärdet är 300 (5 minuter).
- disable_instance_discovery
- bool
Avgör om instansidentifiering utförs när du försöker autentisera. Om du anger värdet true inaktiveras både instansidentifiering och utfärdarvalidering helt. Den här funktionen är avsedd att användas i scenarier där metadataslutpunkten inte kan nås, till exempel i privata moln eller Azure Stack. Processen för instansidentifiering innebär att utfärdarmetadata hämtas från https://login.microsoft.com/ för att verifiera utfärdaren. Genom att ställa in värdet true inaktiveras verifieringen av utfärdaren. Därför är det viktigt att se till att den konfigurerade utfärdarvärden är giltig och tillförlitlig.
Exempel
Skapa en InteractiveBrowserCredential.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Metoder
authenticate |
Autentisera en användare interaktivt. |
close | |
get_token |
Begär en åtkomsttoken för omfång. Den här metoden anropas automatiskt av Azure SDK-klienter. |
authenticate
Autentisera en användare interaktivt.
authenticate(**kwargs: Any) -> AuthenticationRecord
Parametrar
omfång som ska begäras under autentiseringen, till exempel de som tillhandahålls av scopes. Om detta anges cachelagrar en lyckad autentisering en åtkomsttoken för dessa omfång.
Returtyp
Undantag
autentiseringen misslyckades. Felets message
attribut ger en orsak.
close
close() -> None
Undantag
autentiseringen misslyckades. Felets message
attribut ger en orsak.
get_token
Begär en åtkomsttoken för omfång.
Den här metoden anropas automatiskt av Azure SDK-klienter.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parametrar
- scopes
- str
önskade omfång för åtkomsttoken. Den här metoden kräver minst ett omfång. Mer information om omfång finns i https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
ytterligare anspråk som krävs i token, till exempel de som returneras i en resursproviders anspråksutmaning efter ett auktoriseringsfel
- tenant_id
- str
valfri klientorganisation som ska ingå i tokenbegäran.
- enable_cae
- bool
anger om du vill aktivera kontinuerlig åtkomstutvärdering (CAE) för den begärda token. Standardvärdet är False.
Returer
En åtkomsttoken med önskade omfång.
Returtyp
Undantag
autentiseringsuppgiften kan inte försöka autentisera eftersom den saknar nödvändiga data, tillstånd eller plattformsstöd
autentiseringen misslyckades. Felets message
attribut ger en orsak.
användarinteraktion krävs för att hämta en token, och autentiseringsuppgifterna har konfigurerats för att inte starta detta automatiskt. Anropa
för att påbörja interaktiv autentisering.