InteractiveBrowserCredential Classe
Apre un browser per autenticare in modo interattivo un utente.
get_token apre un browser a un URL di accesso fornito da Azure Active Directory e autentica un utente con il flusso del codice di autorizzazione, usando PKCE (Proof Key for Code Exchange) internamente per proteggere il codice.
- Ereditarietà
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Costruttore
InteractiveBrowserCredential(**kwargs: Any)
Parametri
- authority
- str
Autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per Azure Public Cloud (ovvero l'impostazione predefinita). AzureAuthorityHosts definisce le autorità per altri cloud.
- tenant_id
- str
ID tenant di Azure Active Directory. Impostazione predefinita per il tenant "organizzazioni", che può autenticare gli account aziendali o dell'istituto di istruzione.
- client_id
- str
L'ID client dell'applicazione Azure Active Directory accederà. Se non specificato, gli utenti eseguiranno l'autenticazione a un'applicazione di sviluppo di Azure.
- login_hint
- str
un suggerimento per il nome utente per pre-compilare il campo nome utente/indirizzo di posta elettronica della pagina di accesso. Un utente può comunque accedere con un nome utente diverso.
- redirect_uri
- str
un URI di reindirizzamento per l'applicazione identificata da client_id come configurato in Azure Active Directory, ad esempio "http://localhost:8400". Questa operazione è necessaria solo quando si passa un valore per client_id e deve corrispondere a un URI di reindirizzamento nella registrazione dell'applicazione. Le credenziali devono essere in grado di associare un socket a questo URI.
- authentication_record
- AuthenticationRecord
AuthenticationRecord restituito da authenticate
- disable_automatic_authentication
- bool
se True, get_token genererà AuthenticationRequiredError quando è necessaria l'interazione dell'utente per acquisire un token. Il valore predefinito è False.
- cache_persistence_options
- TokenCachePersistenceOptions
configurazione per la memorizzazione nella cache dei token persistenti. Se non specificato, le credenziali memorizzano nella cache i token in memoria.
- timeout
- int
secondi per attendere che l'utente completi l'autenticazione. Il valore predefinito è 300 (5 minuti).
- disable_instance_discovery
- bool
Determina se l'individuazione di istanze viene eseguita durante il tentativo di autenticazione. L'impostazione su true disabilita completamente sia l'individuazione dell'istanza che la convalida dell'autorità. Questa funzionalità è destinata all'uso negli scenari in cui non è possibile raggiungere l'endpoint dei metadati, ad esempio nei cloud privati o in Azure Stack. Il processo di individuazione dell'istanza comporta il recupero dei metadati dell'autorità da https://login.microsoft.com/ per convalidare l'autorità. Impostando questa opzione su True, la convalida dell'autorità è disabilitata. Di conseguenza, è fondamentale assicurarsi che l'host dell'autorità configurata sia valido e affidabile.
Esempio
Creare un oggetto InteractiveBrowserCredential.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Metodi
authenticate |
Autenticare in modo interattivo un utente. |
close | |
get_token |
Richiedere un token di accesso per gli ambiti. Questo metodo viene chiamato automaticamente dai client Azure SDK. |
authenticate
Autenticare in modo interattivo un utente.
authenticate(**kwargs: Any) -> AuthenticationRecord
Parametri
ambiti da richiedere durante l'autenticazione, ad esempio quelli forniti da scopes. Se specificato, l'autenticazione ha esito positivo memorizza nella cache un token di accesso per questi ambiti.
Tipo restituito
Eccezioni
autenticazione non riuscita. L'attributo dell'errore message
fornisce un motivo.
close
close() -> None
Eccezioni
autenticazione non riuscita. L'attributo dell'errore message
fornisce un motivo.
get_token
Richiedere un token di accesso per gli ambiti.
Questo metodo viene chiamato automaticamente dai client Azure SDK.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parametri
- scopes
- str
ambiti desiderati per il token di accesso. Questo metodo richiede almeno un ambito. Per altre informazioni sugli ambiti, vedere https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
attestazioni aggiuntive necessarie nel token, ad esempio quelle restituite nella richiesta di attestazioni di un provider di risorse in seguito a un errore di autorizzazione
- tenant_id
- str
tenant facoltativo da includere nella richiesta di token.
- enable_cae
- bool
indica se abilitare La valutazione dell'accesso continuo (CAE) per il token richiesto. Il valore predefinito è False.
Restituisce
Token di accesso con gli ambiti desiderati.
Tipo restituito
Eccezioni
la credenziale non è in grado di tentare l'autenticazione perché non dispone di dati, stato o supporto della piattaforma necessari
autenticazione non riuscita. L'attributo dell'errore message
fornisce un motivo.
L'interazione utente è necessaria per acquisire un token e la credenziale non è configurata per iniziare automaticamente questa operazione. Chiamata
per iniziare l'autenticazione interattiva.