Sdílet prostřednictvím

CertificateCredential Třída

  • Reference

Ověřuje se jako instanční objekt pomocí certifikátu.

Certifikát musí mít privátní klíč RSA, protože tyto přihlašovací údaje podepisují kontrolní výrazy pomocí RS256. Další informace o konfiguraci ověřování certifikátů najdete v dokumentaci ke službě Azure Active Directory .

Dědičnost
azure.identity._internal.client_credential_base.ClientCredentialBase
CertificateCredential

Konstruktor

CertificateCredential(tenant_id: str, client_id: str, certificate_path: str | None = None, **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

certificate_path
str
výchozí hodnota: None

Volitelná cesta k souboru certifikátu ve formátu PEM nebo PKCS12, včetně privátního klíče. Pokud není k dispozici, vyžaduje se certificate_data .

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.

certificate_data
bytes

Bajty certifikátu ve formátu PEM nebo PKCS12, včetně privátního klíče

password
str nebo bytes

Heslo certifikátu. Pokud je řetězec unicode, bude kódován jako UTF-8. Pokud certifikát vyžaduje jiné kódování, předejte místo toho vhodně zakódované bajty.

send_certificate_chain
bool

Pokud je hodnota True, přihlašovací údaje odešlou veřejný řetěz certifikátů v hlavičce x5c JWT každého požadavku na token. To se vyžaduje pro ověřování názvu subjektu nebo vystavitele (SNI). Výchozí hodnota je False.

cache_persistence_options
TokenCachePersistenceOptions

Konfigurace pro trvalé ukládání tokenů do mezipaměti. Pokud neurčíte, přihlašovací údaje budou tokeny ukládat do mezipaměti.

disable_instance_discovery
bool

Určuje, jestli se při pokusu o ověření provádí zjišťování instancí. Nastavení na hodnotu true zcela zakáže zjišťování instancí i ověřování autority. Tato funkce je určená pro použití ve scénářích, kdy není možné dosáhnout koncového bodu metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instancí zahrnuje načtení metadat autority za https://login.microsoft.com/ účelem ověření autority. Když tuto hodnotu nastavíte na Hodnotu 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ískávat tokeny pro všechny tenanty, ke které má aplikace přístup.

Příklady

Vytvořte CertificateCredential.


   from azure.identity import CertificateCredential

   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_path="<path to PEM/PKCS12 certificate>",
       password="<certificate password if necessary>",
   )

   # Certificate/private key byte data can also be passed directly
   credential = CertificateCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       certificate_data=b"<cert data>",
   )

Metody

close
get_token

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

Klienti sady Azure SDK tuto metodu volali automaticky.

close 

close() -> None

get_token

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

Klienti sady Azure SDK tuto metodu volali 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 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.