InteractiveBrowserCredential Kelas

Membuka browser untuk mengautentikasi pengguna secara interaktif.

get_token membuka browser ke URL masuk yang disediakan oleh Azure Active Directory dan mengautentikasi pengguna di sana dengan alur kode otorisasi, menggunakan PKCE (Proof Key for Code Exchange) secara internal untuk melindungi kode.

Warisan

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

Konstruktor

InteractiveBrowserCredential(**kwargs: Any)

Parameter

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.

tenant_id

str

ID penyewa Azure Active Directory. Default ke penyewa "organisasi", yang dapat mengautentikasi akun kerja atau sekolah.

client_id

str

ID klien pengguna aplikasi Azure Active Directory akan masuk. Jika tidak ditentukan, pengguna akan mengautentikasi ke aplikasi pengembangan Azure.

login_hint

str

saran nama pengguna untuk mengisi bidang nama pengguna/alamat email halaman masuk sebelumnya. Pengguna mungkin masih masuk dengan nama pengguna yang berbeda.

redirect_uri

str

URI pengalihan untuk aplikasi yang diidentifikasi oleh client_id seperti yang dikonfigurasi di Azure Active Directory, misalnya "http://localhost:8400". Ini hanya diperlukan saat meneruskan nilai untuk client_id, dan harus cocok dengan URI pengalihan dalam pendaftaran aplikasi. Kredensial harus dapat mengikat soket ke URI ini.

authentication_record

AuthenticationRecord

AuthenticationRecord dikembalikan oleh authenticate

disable_automatic_authentication

bool

jika True, get_token akan muncul AuthenticationRequiredError ketika interaksi pengguna diperlukan untuk memperoleh token. Default ke False.

cache_persistence_options

TokenCachePersistenceOptions

konfigurasi untuk penembolokan token persisten. Jika tidak ditentukan, kredensial akan menyimpan token dalam memori.

timeout

int

detik untuk menunggu pengguna menyelesaikan autentikasi. Default ke 300 (5 menit).

disable_instance_discovery

bool

Menentukan apakah penemuan instans dilakukan atau tidak saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Fungsionalitas ini ditujukan untuk digunakan dalam skenario di mana titik akhir metadata tidak dapat dicapai, seperti di cloud privat atau Azure Stack. Proses penemuan instans memerlukan pengambilan metadata otoritas dari https://login.microsoft.com/ untuk memvalidasi otoritas. Dengan mengatur ini ke True, validasi otoritas dinonaktifkan. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya.

Contoh

Membuat InteractiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

   credential = InteractiveBrowserCredential(
       client_id="<client_id>",
   )

Metode

authenticate	Mengautentikasi pengguna secara interaktif.
close
get_token	Meminta token akses untuk cakupan. Metode ini dipanggil secara otomatis oleh klien Azure SDK.

authenticate

Mengautentikasi pengguna secara interaktif.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parameter

scopes

Iterable[str]

cakupan untuk meminta selama autentikasi, seperti yang disediakan oleh scopes. Jika disediakan, autentikasi yang berhasil akan menyimpan token akses untuk cakupan ini.

claims

str

klaim tambahan yang diperlukan dalam token, seperti yang disediakan oleh claims

Tipe hasil

AuthenticationRecord

Pengecualian

ClientAuthenticationError

autentikasi gagal. Atribut kesalahan message memberikan alasan.

close

close() -> None

Pengecualian

ClientAuthenticationError

autentikasi gagal. Atribut kesalahan message memberikan alasan.

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.

AuthenticationRequiredError

interaksi pengguna diperlukan untuk memperoleh token, dan kredensial dikonfigurasi untuk tidak memulai ini secara otomatis. Call

authenticate

untuk memulai autentikasi interaktif.