Bagikan melalui

ClientAssertionCredential Kelas

  • Referensi

Mengautentikasi perwakilan layanan dengan pernyataan JWT.

Kredensial ini untuk skenario tingkat lanjut. CertificateCredential memiliki API yang lebih nyaman untuk skenario pernyataan yang paling umum, mengautentikasi perwakilan layanan dengan sertifikat.

Warisan
azure.identity._internal.get_token_mixin.GetTokenMixin
ClientAssertionCredential

Konstruktor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

Parameter

tenant_id
str
Diperlukan

ID penyewa utama. Juga disebut ID "direktori".

client_id
str
Diperlukan

ID klien utama

func
Diperlukan

Panggilan yang mengembalikan pernyataan string. Kredensial akan memanggil ini setiap kali memperoleh token baru.

authority
str

Otoritas titik akhir Azure Active Directory, misalnya "login.microsoftonline.com", otoritas untuk Azure Public Cloud (yang merupakan default). AzureAuthorityHosts mendefinisikan otoritas untuk cloud lain.

additionally_allowed_tenants
List[str]

Menentukan penyewa selain "tenant_id" yang ditentukan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa mana pun yang dapat diakses aplikasi.

Contoh

Buat ClientAssertionCredential.


   from azure.identity import ClientAssertionCredential

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

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

Metode

close
get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

close 

close() -> None

get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parameter

scopes
str
Diperlukan

cakupan yang diinginkan untuk token akses. Metode ini memerlukan setidaknya satu cakupan. Untuk informasi selengkapnya tentang cakupan, lihat https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

klaim tambahan yang diperlukan dalam token, seperti yang dikembalikan dalam tantangan klaim penyedia sumber daya setelah kegagalan otorisasi.

tenant_id
str

penyewa opsional untuk disertakan dalam permintaan token.

enable_cae
bool

menunjukkan apakah akan mengaktifkan Evaluasi Akses Berkelanjutan (CAE) untuk token yang diminta. Default ke False.

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

CredentialUnavailableError

kredensial tidak dapat mencoba autentikasi karena tidak memiliki data, status, atau dukungan platform yang diperlukan

ClientAuthenticationError

autentikasi gagal. Atribut kesalahan message memberikan alasan.