UsernamePasswordCredential Klasa

Uwierzytelnia użytkownika przy użyciu nazwy użytkownika i hasła.

Ogólnie rzecz biorąc, firma Microsoft nie zaleca tego rodzaju uwierzytelniania, ponieważ jest mniej bezpieczna niż inne przepływy uwierzytelniania.

Uwierzytelnianie przy użyciu tego poświadczenia nie jest interaktywne, więc nie jest zgodne z żadną formą uwierzytelniania wieloskładnikowego ani monitowania o zgodę. Aplikacja musi mieć już zgodę od użytkownika lub administratora katalogu.

To poświadczenie może uwierzytelniać tylko konta służbowe; Konta Microsoft nie są obsługiwane. Aby uzyskać więcej informacji na temat typów kont, zobacz dokumentację usługi Azure Active Directory .

Dziedziczenie

azure.identity._internal.interactive.InteractiveCredential

UsernamePasswordCredential

Konstruktor

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

Parametry

client_id

str

Wymagane

Identyfikator klienta aplikacji

username

str

Wymagane

Nazwa użytkownika (zazwyczaj adres e-mail)

password

str

Wymagane

Hasło użytkownika

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 lub domena skojarzona z dzierżawą. Jeśli nie zostanie podana, domyślnie jest to dzierżawa "organizacji", która obsługuje tylko konta służbowe usługi Azure Active Directory.

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.

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 zarówno odnajdywania wystąpień, jak i weryfikacji 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 w usłudze Azure Stack. Proces odnajdywania wystąpień wiąże się z pobieraniem metadanych urzędu z https://login.microsoft.com/ , aby zweryfikować urząd. Ustawiając tę wartość na true, walidacja urzędu jest wyłączona. W związku z tym niezwykle ważne jest, aby upewnić się, że skonfigurowany host urzędu jest prawidłowy i godny zaufania.

additionally_allowed_tenants

List[str]

Określa dzierżawy oprócz określonego "tenant_id", dla którego poświadczenia mogą uzyskiwać tokeny. Dodaj wartość symboli wieloznacznych "*", aby umożliwić poświadczeniu uzyskiwanie tokenów dla dowolnej dzierżawy, do jakiej aplikacja może uzyskać dostęp.

Przykłady

Utwórz nazwę użytkownikaPasswordCredential.

   from azure.identity import UsernamePasswordCredential

   credential = UsernamePasswordCredential(
       client_id="<client_id>",
       username="<username>",
       password="<password>",
   )

Metody

authenticate	Interakcyjne uwierzytelnianie użytkownika.
close
get_token	Zażądaj 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 podane przez usługę scopes. Jeśli zostanie to podane, pomyślne uwierzytelnienie spowoduje buforowanie tokenu dostępu dla tych zakresów.

claims

str

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

Typ zwracany

AuthenticationRecord

Wyjątki

ClientAuthenticationError

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

close

close() -> None

Wyjątki

ClientAuthenticationError

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

get_token

Zażądaj 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 wyzwaniu oświadczeń 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ć ocenę ciągłego 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 daje przyczynę.

AuthenticationRequiredError

interakcja użytkownika jest niezbędna do uzyskania tokenu, a poświadczenia nie są konfigurowane do automatycznego rozpoczęcia. Call

authenticate

aby rozpocząć uwierzytelnianie interakcyjne.