Sdílet prostřednictvím

ClientAssertionCredential Třída

  • Reference

Ověří instanční objekt pomocí kontrolního výrazu JWT.

Tyto přihlašovací údaje jsou určené pro pokročilé scénáře. CertificateCredential má pohodlnější rozhraní API pro nejběžnější scénář kontrolního výrazu, kdy se instanční objekt ověřuje certifikátem.

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

Konstruktor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], 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 objektu zabezpečení

func
Vyžadováno

Volatelné, které vrací řetězcový kontrolní výraz. Přihlašovací údaje ho budou volat pokaždé, když získá nový token.

authority
str

Autorita koncového bodu Azure Active Directory, například "login.microsoftonline.com", autorita pro veřejný cloud Azure (což je výchozí nastavení). AzureAuthorityHosts definuje autority pro jiné cloudy.

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ískávat tokeny pro všechny tenanty, ke které má aplikace přístup.

Příklady

Vytvořte ClientAssertionCredential.


   from azure.identity.aio import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

Metody

close

Zavřete relaci přenosu přihlašovacích údajů.
get_token

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

Klienti sady Azure SDK tuto metodu volali automaticky.

close

Zavřete relaci přenosu přihlašovacích údajů.

async close() -> None

get_token

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

Klienti sady Azure SDK tuto metodu volali 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 pro přístupový token. 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 vrátí při napadení deklarací 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 nemohou pokusit o ověření, protože nemají požadovaná data, stav nebo podporu platformy.

ClientAuthenticationError

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