InteractiveBrowserCredential Klas
Hiermee opent u een browser om een gebruiker interactief te verifiëren.
get_token opent een browser naar een aanmeldings-URL van Azure Active Directory en verifieert daar een gebruiker met de autorisatiecodestroom, waarbij PKCE (Proof Key for Code Exchange) intern wordt gebruikt om de code te beveiligen.
- Overname
-
azure.identity._internal.interactive.InteractiveCredentialInteractiveBrowserCredential
Constructor
InteractiveBrowserCredential(**kwargs: Any)
Parameters
- authority
- str
Instantie van een Azure Active Directory-eindpunt, bijvoorbeeld 'login.microsoftonline.com', de instantie voor de openbare Azure-cloud (dit is de standaardinstelling). AzureAuthorityHosts definieert instanties voor andere clouds.
- tenant_id
- str
een Azure Active Directory-tenant-id. De standaardinstelling is de tenant 'organisaties', waarmee werk- of schoolaccounts kunnen worden geverifieerd.
- client_id
- str
Client-id van de Azure Active Directory-toepassing waarbij gebruikers zich aanmelden. Als dit niet wordt opgegeven, verifiëren gebruikers zich bij een Azure-ontwikkelingstoepassing.
- login_hint
- str
een gebruikersnaamsuggesties om het veld gebruikersnaam/e-mailadres van de aanmeldingspagina vooraf in te vullen. Een gebruiker kan zich nog steeds aanmelden met een andere gebruikersnaam.
- redirect_uri
- str
een omleidings-URI voor de toepassing die is geïdentificeerd door client_id zoals geconfigureerd in Azure Active Directory, bijvoorbeeld 'http://localhost:8400'. Dit is alleen vereist bij het doorgeven van een waarde voor client_id en moet overeenkomen met een omleidings-URI in de registratie van de toepassing. De referentie moet een socket kunnen binden aan deze URI.
- authentication_record
- AuthenticationRecord
AuthenticationRecord geretourneerd door authenticate
- disable_automatic_authentication
- bool
indien Waar, get_token wordt weergegeven AuthenticationRequiredError wanneer gebruikersinteractie is vereist om een token te verkrijgen. Standaard ingesteld op False.
- cache_persistence_options
- TokenCachePersistenceOptions
configuratie voor permanente tokencache. Als dit niet wordt opgegeven, worden tokens in het geheugen opgeslagen in de cache van de referentie.
- timeout
- int
seconden om te wachten totdat de gebruiker de verificatie heeft voltooid. De standaardwaarde is 300 (5 minuten).
- disable_instance_discovery
- bool
Bepaalt of exemplaardetectie wordt uitgevoerd bij een verificatiepoging. Als u dit instelt op true, wordt zowel exemplaardetectie als instantievalidatie volledig uitgeschakeld. Deze functionaliteit is bedoeld voor gebruik in scenario's waarin het eindpunt voor metagegevens niet kan worden bereikt, zoals in privéclouds of Azure Stack. Het proces van exemplaardetectie omvat het ophalen van instantiemetagegevens van https://login.microsoft.com/ om de instantie te valideren. Als u dit instelt op Waar, wordt de validatie van de instantie uitgeschakeld. Als gevolg hiervan is het van cruciaal belang om ervoor te zorgen dat de geconfigureerde instantiehost geldig en betrouwbaar is.
Voorbeelden
Maak een InteractiveBrowserCredential.
from azure.identity import InteractiveBrowserCredential
credential = InteractiveBrowserCredential(
client_id="<client_id>",
)
Methoden
authenticate |
Een gebruiker interactief verifiëren. |
close | |
get_token |
Een toegangstoken aanvragen voor bereiken. Deze methode wordt automatisch aangeroepen door Azure SDK-clients. |
authenticate
Een gebruiker interactief verifiëren.
authenticate(**kwargs: Any) -> AuthenticationRecord
Parameters
bereiken die tijdens de verificatie moeten worden aangevraagd, zoals de bereiken die worden geleverd door scopes. Als dit wordt opgegeven, wordt met een geslaagde verificatie een toegangstoken voor deze bereiken in de cache opgeslagen.
- claims
- str
aanvullende claims die zijn vereist in het token, zoals de claims die worden geleverd door claims
Retourtype
Uitzonderingen
verificatie is mislukt. Het kenmerk van de message
fout geeft een reden aan.
close
close() -> None
Uitzonderingen
verificatie is mislukt. Het kenmerk van de message
fout geeft een reden aan.
get_token
Een toegangstoken aanvragen voor bereiken.
Deze methode wordt automatisch aangeroepen door Azure SDK-clients.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parameters
- scopes
- str
gewenste bereiken voor het toegangstoken. Voor deze methode is ten minste één bereik vereist. Zie voor meer informatie over bereiken https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
aanvullende claims die zijn vereist in het token, zoals de claims die worden geretourneerd in de claimvraag van een resourceprovider na een autorisatiefout
- tenant_id
- str
optionele tenant die moet worden opgenomen in de tokenaanvraag.
- enable_cae
- bool
geeft aan of continue toegangsevaluatie (CAE) moet worden ingeschakeld voor het aangevraagde token. Standaard ingesteld op False.
Retouren
Een toegangstoken met de gewenste bereiken.
Retourtype
Uitzonderingen
de referentie kan geen verificatie uitvoeren omdat de vereiste gegevens, status of platformondersteuning ontbreekt
verificatie is mislukt. Het kenmerk van de message
fout geeft een reden aan.
gebruikersinteractie is nodig om een token te verkrijgen en de referentie is geconfigureerd om dit niet automatisch te starten. Call
om interactieve verificatie te starten.