Sdílet prostřednictvím

OnBehalfOfCredential Třída

  • Reference

Ověřuje instanční objekt prostřednictvím toku on-behalf-of.

Tento tok obvykle používají služby střední vrstvy, které autorizují požadavky na jiné služby s delegovanou identitou uživatele. Vzhledem k tomu, že se nejedná o tok interaktivního ověřování, musí mít aplikace, která ho používá, souhlas správce se všemi delegovanými oprávněními, než za ně požádá o tokeny. Podrobnější popis toku on-behalf-of najdete v dokumentaci ke službě Azure Active Directory .

Dědičnost
azure.identity.aio._internal.AsyncContextManager
OnBehalfOfCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
OnBehalfOfCredential

Konstruktor

OnBehalfOfCredential(tenant_id: str, client_id: str, *, client_certificate: bytes | None = None, client_secret: str | None = None, user_assertion: str, **kwargs: Any)

Parametry

tenant_id
str
Vyžadováno

ID tenanta instančního objektu Označuje se také jako ID adresáře.

client_id
str
Vyžadováno

ID klienta instančního objektu

client_secret
str

Nepovinný parametr. Tajný klíč klienta pro ověření instančního objektu. Je nutné zadat client_secret nebo client_certificate .

client_certificate
bytes

Nepovinný parametr. Bajty certifikátu ve formátu PEM nebo PKCS12, včetně privátního klíče pro ověření instančního objektu. Je nutné zadat client_secret nebo client_certificate .

user_assertion
str

Povinná hodnota. Přístupový token, který přihlašovací údaje použijí jako uživatelský kontrolní výraz při žádosti o tokeny on-behalf-of

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.

password
str nebo bytes

Heslo certifikátu. Používá se pouze v případech, kdy je k dispozici client_certificate . Pokud je tato hodnota řetězec unicode, bude kódována jako UTF-8. Pokud certifikát vyžaduje jiné kódování, předejte místo toho vhodně zakódované bajty.

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


   from azure.identity.aio import OnBehalfOfCredential

   credential = OnBehalfOfCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
       user_assertion="<access_token>",
   )

Metody

close
get_token

Vyžádejte si přístupový token pro obory.

Klienti sady Azure SDK volali tuto metodu automaticky.

close 

async close() -> None

get_token

Vyžádejte si přístupový token pro obory.

Klienti sady Azure SDK volali tuto metodu automaticky.

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