UsernamePasswordCredential Třída

Ověří uživatele pomocí uživatelského jména a hesla.

Microsoft obecně tento druh ověřování nedoporučuje, protože je méně bezpečný než jiné ověřovací toky.

Ověřování pomocí těchto přihlašovacích údajů není interaktivní, takže není kompatibilní s žádnou formou vícefaktorového ověřování nebo výzvy k vyjádření souhlasu. Aplikace už musí mít souhlas uživatele nebo správce adresáře.

Tyto přihlašovací údaje mohou ověřovat pouze pracovní a školní účty; Účty Microsoft nejsou podporované. Další informace o typech účtů najdete v dokumentaci ke službě Azure Active Directory .

Dědičnost

azure.identity._internal.interactive.InteractiveCredential

UsernamePasswordCredential

Konstruktor

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

Parametry

client_id

str

Vyžadováno

ID klienta aplikace

username

str

Vyžadováno

Uživatelské jméno uživatele (obvykle e-mailová adresa)

password

str

Vyžadováno

Heslo uživatele

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 nebo doména přidružená k tenantovi. Pokud není zadaný, ve výchozím nastavení se používá tenant organizace, který podporuje jenom pracovní nebo školní účty Azure Active Directory.

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.

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ý.

additionally_allowed_tenants

List[str]

Určuje tenanty kromě zadaného "tenant_id", pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem *, aby přihlašovací údaje mohly získat tokeny pro všechny tenanty, ke které má aplikace přístup.

Příklady

Vytvořte UsernamePasswordCredential.

   from azure.identity import UsernamePasswordCredential

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

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) -> AuthenticationRecord

Parametry

scopes

Iterable[str]

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.

claims

str

další deklarace identity vyžadované v tokenu, například ty, které poskytuje claims

Návratový typ

AuthenticationRecord

Výjimky

ClientAuthenticationError

ověření se nezdařilo. Atribut chyby message uvádí důvod.

close

close() -> None

Výjimky

ClientAuthenticationError

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) -> AccessToken

Parametry

scopes

str

Vyžadováno

požadované obory přístupového tokenu. Tato metoda vyžaduje alespoň jeden obor. Další informace o oborech najdete v tématu https://learn.microsoft.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

AccessToken

Výjimky

CredentialUnavailableError

přihlašovací údaje se nemůžou pokusit o ověření, protože jim chybí požadovaná data, stav nebo podpora platformy

ClientAuthenticationError

ověření se nezdařilo. Atribut chyby message uvádí důvod.

AuthenticationRequiredError

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

authenticate

pro zahájení interaktivního ověřování.