InteractiveBrowserCredential Třída
Otevře prohlížeč pro interaktivní ověřování uživatele.
get_token otevře prohlížeč na přihlašovací adresu URL, kterou poskytuje Azure Active Directory, a ověří uživatele v něm s tokem autorizačního kódu, a to pomocí pkCE (proof key for Code Exchange) interně k ochraně kódu.
- Dědičnost
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Konstruktor
InteractiveBrowserCredential(**kwargs: Any)Parametry
- authority
- str
Autorita koncového bodu Azure Active Directory, například "login.microsoftonline.com", autorita pro veřejný cloud Azure (která je výchozí). AzureAuthorityHosts definuje autority pro jiné cloudy.
- tenant_id
- str
ID tenanta Azure Active Directory. Výchozí hodnota je tenant organizace, který může ověřovat pracovní nebo školní účty.
- client_id
- str
ID klienta aplikace Azure Active Directory, ke které se uživatelé budou přihlašovat. Pokud uživatel není zadaný, ověří se ve vývojové aplikaci Azure.
- login_hint
- str
a username suggestion to pre-fill the login page's username/email address. Uživatel se přesto může přihlásit pomocí jiného uživatelského jména.
- redirect_uri
- str
identifikátor URI přesměrování pro aplikaci identifikovanou client_id nakonfigurovanou v Azure Active Directory, například .http://localhost:8400 To se vyžaduje pouze při předávání hodnoty pro client_id a musí odpovídat identifikátoru URI přesměrování v registraci aplikace. Přihlašovací údaje musí být schopné vytvořit vazbu soketu k tomuto identifikátoru URI.
- authentication_record
- AuthenticationRecord
AuthenticationRecord vrácený authenticate
- disable_automatic_authentication
- bool
Pokud true, get_token vyvolá AuthenticationRequiredError se, když se k získání tokenu vyžaduje interakce uživatele. Výchozí hodnota je False.
- cache_persistence_options
- TokenCachePersistenceOptions
konfigurace pro ukládání trvalých tokenů do mezipaměti. Pokud ho nezadáte, přihlašovací údaje uloží tokeny do mezipaměti.
- timeout
- int
sekund, než uživatel dokončí ověřování. Výchozí hodnota je 300 (5 minut).
- disable_instance_discovery
- bool
Určuje, zda se při pokusu o ověření provádí zjišťování instancí. Pokud tuto hodnotu nastavíte na true, zjišťování instancí i ověření autority se úplně zakáže. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila. Když tuto hodnotu nastavíte na True, ověření autority se zakáže. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný.
Příklady
Vytvořte InteractiveBrowserCredential.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Metody
| authenticate |
Interaktivní ověřování uživatele |
| close | |
| get_token |
Vyžádejte si přístupový token pro obory. Klienti sady Azure SDK volali tuto metodu automaticky. |
authenticate
Interaktivní ověřování uživatele
authenticate(**kwargs: Any) -> AuthenticationRecordParametry
rozsahy, které mají být požadovány během ověřování, například obory poskytované nástrojem scopes. Pokud je k dispozici, úspěšné ověření uloží přístupový token pro tyto obory do mezipaměti.
Návratový typ
Výjimky
ověření se nezdařilo. Atribut chyby message uvádí důvod.
close
close() -> NoneVýjimky
ověření se nezdařilo. Atribut chyby message uvádí důvod.
get_token
Vyžádejte si přístupový token pro obory.
Klienti sady Azure SDK volali tuto metodu automaticky.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessTokenParametry
- scopes
- str
požadované obory přístupového tokenu. Tato metoda vyžaduje alespoň jeden obor. Další informace o oborech najdete v tématu https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
Další deklarace identity vyžadované v tokenu, například ty, které se vrací při výzvě k deklaraci identity poskytovatele prostředků po selhání autorizace
- tenant_id
- str
volitelného tenanta, který se má zahrnout do žádosti o token.
- enable_cae
- bool
určuje, jestli se má pro požadovaný token povolit průběžné vyhodnocování přístupu (CAE). Výchozí hodnota je False.
Návraty
Přístupový token s požadovanými obory.
Návratový typ
Výjimky
přihlašovací údaje se nemůžou pokusit o ověření, protože jim chybí požadovaná data, stav nebo podpora platformy
ověření se nezdařilo. Atribut chyby message uvádí důvod.
K získání tokenu je nutná interakce uživatele a přihlašovací údaje jsou nakonfigurované tak, aby se s tím nezačínat automaticky. Call
pro zahájení interaktivního ověřování.