InteractiveBrowserCredential Klasa

Otwiera przeglądarkę w celu interaktywnego uwierzytelniania użytkownika.

get_token Otwiera przeglądarkę pod adresem URL logowania udostępnianym przez usługę Azure Active Directory i uwierzytelnia użytkownika w przepływie kodu autoryzacji przy użyciu klucza weryfikacji dla programu Code Exchange wewnętrznie w celu ochrony kodu.

Dziedziczenie

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

Konstruktor

InteractiveBrowserCredential(**kwargs: Any)

Parametry

authority

str

Urząd punktu końcowego usługi Azure Active Directory, na przykład "login.microsoftonline.com", urząd dla chmury publicznej platformy Azure (który jest domyślny). AzureAuthorityHosts definiuje władze dla innych chmur.

tenant_id

str

identyfikator dzierżawy usługi Azure Active Directory. Domyślnie jest to dzierżawa "organizacji", która może uwierzytelniać konta służbowe.

client_id

str

Identyfikator klienta użytkowników aplikacji usługi Azure Active Directory będzie się logować. Jeśli nie zostanie to określona, użytkownicy będą uwierzytelniać się w aplikacji dewelopera platformy Azure.

login_hint

str

sugestia nazwy użytkownika w celu wstępnego wypełnienia pola nazwy użytkownika/adresu e-mail strony logowania. Użytkownik może nadal logować się przy użyciu innej nazwy użytkownika.

redirect_uri

str

identyfikator URI przekierowania dla aplikacji zidentyfikowanej przez client_id zgodnie z konfiguracją w usłudze Azure Active Directory, na przykład "http://localhost:8400". Jest to wymagane tylko w przypadku przekazywania wartości dla client_id i musi być zgodne z identyfikatorem URI przekierowania w rejestracji aplikacji. Poświadczenie musi mieć możliwość powiązania gniazda z tym identyfikatorem URI.

authentication_record

AuthenticationRecord

AuthenticationRecord zwrócone przez authenticate

disable_automatic_authentication

bool

Jeśli wartość True, zostanie wywołana AuthenticationRequiredError wartość , get_token gdy interakcja użytkownika jest wymagana do uzyskania tokenu. Wartość domyślna to False.

cache_persistence_options

TokenCachePersistenceOptions

konfiguracja trwałego buforowania tokenów. Jeśli nie zostanie określona, poświadczenie będzie buforowane tokeny w pamięci.

timeout

int

sekundy oczekiwania na ukończenie uwierzytelniania przez użytkownika. Wartość domyślna to 300 (5 minut).

disable_instance_discovery

bool

Określa, czy odnajdywanie wystąpień jest wykonywane podczas próby uwierzytelnienia. Ustawienie wartości true spowoduje całkowite wyłączenie weryfikacji odnajdywania wystąpień i urzędu. Ta funkcja jest przeznaczona do użycia w scenariuszach, w których nie można uzyskać dostępu do punktu końcowego metadanych, na przykład w chmurach prywatnych lub usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ programu w celu zweryfikowania urzędu. Ustawiając wartość True, walidacja urzędu jest wyłączona. W związku z tym niezwykle ważne jest upewnienie się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania.

Przykłady

Utwórz obiekt InteractiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

   credential = InteractiveBrowserCredential(
       client_id="<client_id>",
   )

Metody

authenticate	Interakcyjne uwierzytelnianie użytkownika.
close
get_token	Żądanie tokenu dostępu dla zakresów. Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

authenticate

Interakcyjne uwierzytelnianie użytkownika.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parametry

scopes

Iterable[str]

zakresy żądania podczas uwierzytelniania, takie jak te udostępniane przez scopesusługę . Jeśli zostanie podana, pomyślne uwierzytelnianie spowoduje buforowanie tokenu dostępu dla tych zakresów.

claims

str

dodatkowe oświadczenia wymagane w tokenie, takie jak te dostarczone przez claims

Typ zwracany

AuthenticationRecord

Wyjątki

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Atrybut błędu message podaje przyczynę.

close

close() -> None

Wyjątki

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Atrybut błędu message podaje przyczynę.

get_token

Żądanie tokenu dostępu dla zakresów.

Ta metoda jest wywoływana automatycznie przez klientów zestawu Azure SDK.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parametry

scopes

str

Wymagane

żądane zakresy tokenu dostępu. Ta metoda wymaga co najmniej jednego zakresu. Aby uzyskać więcej informacji na temat zakresów, zobacz https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

dodatkowe oświadczenia wymagane w tokenie, takie jak te zwrócone w żądaniach dostawcy zasobów, po niepowodzeniu autoryzacji

tenant_id

str

opcjonalna dzierżawa do uwzględnienia w żądaniu tokenu.

enable_cae

bool

wskazuje, czy włączyć ciągłą ocenę dostępu (CAE) dla żądanego tokenu. Wartość domyślna to False.

Zwraca

Token dostępu z żądanymi zakresami.

Typ zwracany

AccessToken

Wyjątki

CredentialUnavailableError

poświadczenie nie może podjąć próby uwierzytelnienia, ponieważ brakuje wymaganych danych, stanu lub obsługi platformy

ClientAuthenticationError

uwierzytelnianie nie powiodło się. Atrybut błędu message podaje przyczynę.

AuthenticationRequiredError

interakcja użytkownika jest niezbędna do uzyskania tokenu, a poświadczenie nie jest konfigurowane do automatycznego rozpoczynania tego działania. Call

authenticate

aby rozpocząć uwierzytelnianie interakcyjne.