InteractiveBrowserCredential Osztály
Megnyit egy böngészőt egy felhasználó interaktív hitelesítéséhez.
get_token megnyit egy böngészőt az Azure Active Directory által biztosított bejelentkezési URL-címre, és hitelesíti az ott lévő felhasználót az engedélyezési kód folyamatával a PKCE (Proof Key for Code Exchange) belső használatával a kód védelméhez.
- Öröklődés
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Konstruktor
InteractiveBrowserCredential(**kwargs: Any)
Paraméterek
- authority
- str
Egy Azure Active Directory-végpont szolgáltatója, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója (ez az alapértelmezett). AzureAuthorityHosts más felhők hatóságait határozza meg.
- tenant_id
- str
egy Azure Active Directory-bérlőazonosító. Alapértelmezés szerint a "szervezetek" bérlője hitelesíti a munkahelyi vagy iskolai fiókokat.
- client_id
- str
Az Azure Active Directory-alkalmazás felhasználóinak ügyfél-azonosítója be fog jelentkezni. Ha nincs meghatározva, a felhasználók hitelesítést fognak végezni egy Azure-fejlesztési alkalmazáson.
- login_hint
- str
egy felhasználónévre vonatkozó javaslat a bejelentkezési oldal felhasználónév/e-mail-cím mezőjének előzetes kitöltéséhez. Előfordulhat, hogy egy felhasználó továbbra is másik felhasználónévvel jelentkezik be.
- redirect_uri
- str
a client_id által az Azure Active Directoryban konfigurált alkalmazás átirányítási URI-ja, például "http://localhost:8400". Ez csak a client_id értékének átadásakor szükséges, és meg kell egyeznie az alkalmazás regisztrációjában szereplő átirányítási URI-nak. A hitelesítő adatoknak képesnek kell lenniük arra, hogy egy szoftvercsatornát kössenek ehhez az URI-hoz.
- authentication_record
- AuthenticationRecord
AuthenticationRecord által visszaadott authenticate
- disable_automatic_authentication
- bool
ha igaz, akkor akkor jelenik megAuthenticationRequiredError, get_token ha a jogkivonat beszerzéséhez felhasználói beavatkozásra van szükség. Alapértelmezés szerint Hamis.
- cache_persistence_options
- TokenCachePersistenceOptions
konfigurálás az állandó jogkivonat-gyorsítótárazáshoz. Ha nincs meghatározva, a hitelesítő adat gyorsítótárazza a tokeneket a memóriában.
- timeout
- int
másodpercben várja meg, amíg a felhasználó befejezi a hitelesítést. Alapértelmezés szerint 300 (5 perc).
- disable_instance_discovery
- bool
Meghatározza, hogy a példányfelderítés a hitelesítés megkísérlésekor történik-e. Ha ezt igaz értékre állítja, az teljesen letiltja a példányfelderítést és a hitelesítést. Ez a funkció olyan esetekben használható, amikor a metaadat-végpont nem érhető el, például magánfelhőkben vagy az Azure Stackben. A példányfelderítés folyamata magában foglalja a szolgáltató metaadatainak https://login.microsoft.com/ lekérését a szolgáltató ellenőrzéséhez. Ha ezt Igaz értékre állítja, a szolgáltató ellenőrzése le van tiltva. Ennek eredményeképpen elengedhetetlen annak biztosítása, hogy a konfigurált szolgáltatói gazdagép érvényes és megbízható legyen.
Példák
Hozzon létre egy InteractiveBrowserCredential azonosítót.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Metódusok
authenticate |
Felhasználó interaktív hitelesítése. |
close | |
get_token |
Hozzáférési jogkivonat kérése a hatókörökhöz. Ezt a metódust az Azure SDK-ügyfelek automatikusan meghívják. |
authenticate
Felhasználó interaktív hitelesítése.
authenticate(**kwargs: Any) -> AuthenticationRecord
Paraméterek
A hitelesítés során kérendő hatókörök, például a által scopesbiztosított hatókörök. Ha meg van adva, a sikeres hitelesítés gyorsítótáraz egy hozzáférési jogkivonatot ezekhez a hatókörökhöz.
Visszatérési típus
Kivételek
a hitelesítés nem sikerült. A hiba attribútuma message
okot ad.
close
close() -> None
Kivételek
a hitelesítés nem sikerült. A hiba attribútuma message
okot ad.
get_token
Hozzáférési jogkivonat kérése a hatókörökhöz.
Ezt a metódust az Azure SDK-ügyfelek automatikusan meghívják.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Paraméterek
- scopes
- str
a hozzáférési jogkivonat kívánt hatókörei. Ehhez a metódushoz legalább egy hatókör szükséges. A hatókörökről további információt a következő témakörben talál https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc: .
- claims
- str
a jogkivonathoz szükséges további jogcímek, például az erőforrás-szolgáltató jogcímekkel kapcsolatos kihívásában az engedélyezési hiba után visszaadott jogcímek
- tenant_id
- str
nem kötelező bérlő, amely szerepel a jogkivonat-kérelemben.
- enable_cae
- bool
azt jelzi, hogy engedélyezi-e a folyamatos hozzáférés-kiértékelést (CAE) a kért jogkivonathoz. Alapértelmezés szerint Hamis.
Válaszok
Hozzáférési jogkivonat a kívánt hatókörökkel.
Visszatérési típus
Kivételek
a hitelesítő adat nem tud hitelesítést kísérelni, mert nem rendelkezik a szükséges adatokkal, állapottal vagy platformtámogatással
a hitelesítés nem sikerült. A hiba attribútuma message
okot ad.
a felhasználói beavatkozás szükséges egy jogkivonat beszerzéséhez, és a hitelesítő adatok úgy vannak konfigurálva, hogy ne kezdődjön meg automatikusan. Call
az interaktív hitelesítés megkezdéséhez.
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: