Bagikan melalui

AuthorizationCodeCredential Kelas

  • Referensi

Mengautentikasi dengan menukarkan kode otorisasi yang sebelumnya diperoleh dari Azure Active Directory.

Lihat Dokumentasi Azure Active Directory untuk informasi selengkapnya tentang alur autentikasi.

Warisan
azure.identity._internal.get_token_mixin.GetTokenMixin
AuthorizationCodeCredential

Konstruktor

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)

Parameter

tenant_id
str
Diperlukan

ID dari penyewa Azure Active Directory aplikasi. Juga disebut ID "direktori".

client_id
str
Diperlukan

ID klien aplikasi

authorization_code
str
Diperlukan

Kode otorisasi dari masuk pengguna

redirect_uri
str
Diperlukan

URI pengalihan aplikasi. Harus cocok dengan URI yang digunakan untuk meminta kode otorisasi.

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.

client_secret
str

Salah satu rahasia klien aplikasi. Diperlukan hanya untuk aplikasi web dan API web.

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


   from azure.identity import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

Metode

close

Tutup sesi transportasi kredensial.
get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

Pertama kali metode ini dipanggil, kredensial akan menukarkan kode otorisasinya. Pada panggilan berikutnya, kredensial akan mengembalikan token akses cache atau menukarkan token refresh, jika memperoleh token refresh setelah menukarkan kode otorisasi.

close

Tutup sesi transportasi kredensial.

close() -> None

get_token

Meminta token akses untuk cakupan.

Metode ini dipanggil secara otomatis oleh klien Azure SDK.

Pertama kali metode ini dipanggil, kredensial akan menukarkan kode otorisasinya. Pada panggilan berikutnya, kredensial akan mengembalikan token akses cache atau menukarkan token refresh, jika memperoleh token refresh setelah menukarkan kode otorisasi.

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

Mengembalikan

Token akses dengan cakupan yang diinginkan.

Tipe hasil

AccessToken

Pengecualian

ClientAuthenticationError

autentikasi gagal. Atribut kesalahan message memberikan alasan. Respons kesalahan apa pun dari Azure Active Directory tersedia sebagai atribut kesalahan response .