AuthenticationContext Kelas

Mengambil token autentikasi dari Azure Active Directory.

Untuk penggunaan, lihat folder "sampel" di: https://github.com/AzureAD/azure-activedirectory-library-for-python

Membuat objek AuthenticationContext baru.

Secara default otoritas akan diperiksa terhadap daftar otoritas Azure Active Directory yang diketahui. Jika otoritas tidak diakui sebagai salah satu otoritas terkenal ini maka akuisisi token akan gagal. Perilaku ini dapat dimatikan melalui parameter validate_authority di bawah ini.

Warisan

builtins.object

AuthenticationContext

Konstruktor

AuthenticationContext(authority, validate_authority=None, cache=None, api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None)

Parameter

authority

str

Diperlukan

URL yang mengidentifikasi otoritas token. Ini harus dalam format https://login.microsoftonline.com/your_tenant

validate_authority

bool

nilai default: None

(opsional) Mengaktifkan atau menonaktifkan validasi otoritas. Parameter ini default ke true.

cache

TokenCache

nilai default: None

(opsional) Mengatur cache token yang digunakan oleh instans AuthenticationContext ini. Jika parameter ini tidak diatur, maka default digunakan. Instans cache hanya digunakan oleh instans AuthenticationContext tersebut dan tidak dibagikan kecuali telah diteruskan secara manual selama pembangunan AuthenticationContexts lainnya.

api_version

nilai default: None

(opsional) Menentukan versi API menggunakan pada kawat. Secara historis memiliki nilai default yang dikodekan secara permanen sebagai "1.0". Pengembang telah didorong untuk mengaturnya sebagai Tidak Ada secara eksplisit, yang berarti versi API yang mendasar akan dipilih secara otomatis. Mulai dari ADAL Python 1.0, nilai default ini menjadi Tidak Ada.

timeout

nilai default: None

(opsional) meminta waktu habis. Berapa lama menunggu server mengirim data sebelum menyerah, sebagai float, atau tuple (waktu habis koneksi, waktu baca habis).

enable_pii

nilai default: False

(opsional) Kecuali ini diatur ke True, tidak akan ada Informasi Pengidentifikasi Pribadi (PII) yang ditulis dalam log.

verify_ssl

nilai default: None

(opsional) permintaan memverifikasi. Baik boolean, dalam hal ini mengontrol apakah kami memverifikasi sertifikat TLS server, atau string, dalam hal ini harus menjadi jalur ke bundel CA untuk digunakan. Jika nilai ini tidak disediakan, dan ADAL_PYTHON_SSL_NO_VERIFY env varaible diatur, perilaku setara dengan verify_ssl=False.

proxies

nilai default: None

(opsional) meminta proksi. Protokol pemetaan kamus ke URL proksi. Lihat http://docs.python-requests.org/en/master/user/advanced/#proxies untuk detailnya.

Metode

acquire_token	Mendapatkan token untuk sumber daya tertentu melalui token yang di-cache.
acquire_token_with_authorization_code	Mendapatkan token untuk sumber daya tertentu melalui kode otorisasi untuk aplikasi server.
acquire_token_with_client_certificate	Mendapatkan token untuk sumber daya tertentu melalui kredensial sertifikat
acquire_token_with_client_credentials	Mendapatkan token untuk sumber daya tertentu melalui kredensial klien.
acquire_token_with_device_code	Mendapatkan token akses baru menggunakan melalui kode perangkat.
acquire_token_with_refresh_token	Mendapatkan token untuk sumber daya tertentu melalui token refresh
acquire_token_with_username_password	Mendapatkan token untuk sumber daya tertentu melalui kredensial pengguna.
acquire_user_code	Mendapatkan info kode pengguna yang berisi user_code, device_code untuk mengautentikasi pengguna di perangkat.
cancel_request_to_get_token_with_device_code	Membatalkan permintaan polling untuk mendapatkan token dengan kode perangkat.

acquire_token

Mendapatkan token untuk sumber daya tertentu melalui token yang di-cache.

acquire_token(resource, user_id, client_id)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

user_id

str

Diperlukan

Nama pengguna atas nama aplikasi ini sedang mengautentikasi.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

Mengembalikan

dic dengan beberapa kunci, termasuk "accessToken" dan "refreshToken".

acquire_token_with_authorization_code

Mendapatkan token untuk sumber daya tertentu melalui kode otorisasi untuk aplikasi server.

acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)

Parameter

authorization_code

str

Diperlukan

Kode otorisasi yang dikembalikan dari klien.

redirect_uri

str

Diperlukan

uri pengalihan yang digunakan dalam panggilan otorisasi.

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

client_secret

str

nilai default: None

(hanya untuk klien rahasia) Rahasia klien OAuth dari aplikasi panggilan. Parameter ini jika tidak diatur, default ke Tidak Ada

code_verifier

str

nilai default: None

(opsional) Pemverifikasi kode yang digunakan untuk mendapatkan kode otorisasi jika PKCE digunakan dalam permintaan pemberian kode otorisasi. (biasanya digunakan oleh klien publik) Parameter ini jika tidak diatur, default ke Tidak Ada

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken" dan "refreshToken".

acquire_token_with_client_certificate

Mendapatkan token untuk sumber daya tertentu melalui kredensial sertifikat

acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

certificate

str

Diperlukan

Kunci privat sertifikat yang dikodekan PEM.

thumbprint

str

Diperlukan

thumbprint sertifikat yang dikodekan hex.

public_certificate

nilai default: None

jika tidak Tidak Ada, itu akan dikirim ke layanan untuk nama subjek dan autentikasi berbasis penerbit, yaitu untuk mendukung gulungan otomatis sertifikasi. Nilai harus cocok dengan parameter kunci privat sertifikat.

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken".

acquire_token_with_client_credentials

Mendapatkan token untuk sumber daya tertentu melalui kredensial klien.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

client_secret

str

Diperlukan

Rahasia klien OAuth dari aplikasi panggilan.

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken".

acquire_token_with_device_code

Mendapatkan token akses baru menggunakan melalui kode perangkat.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

user_code_info

dict

Diperlukan

Info kode dari pemanggilan "acquire_user_code"

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken" dan "refreshToken".

acquire_token_with_refresh_token

Mendapatkan token untuk sumber daya tertentu melalui token refresh

acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)

Parameter

refresh_token

str

Diperlukan

Token refresh dikembalikan dalam respons tokne dari pemanggilan acquireToken sebelumnya.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

client_secret

str

nilai default: None

(opsional) Rahasia klien OAuth dari aplikasi panggilan.

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken" dan "refreshToken".

acquire_token_with_username_password

Mendapatkan token untuk sumber daya tertentu melalui kredensial pengguna.

acquire_token_with_username_password(resource, username, password, client_id)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya yang tokennya valid.

username

str

Diperlukan

Nama pengguna atas nama aplikasi ini sedang mengautentikasi.

password

str

Diperlukan

Kata sandi pengguna bernama dalam parameter nama pengguna.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

Mengembalikan

dict dengan beberapa kunci, termasuk "accessToken" dan "refreshToken".

acquire_user_code

Mendapatkan info kode pengguna yang berisi user_code, device_code untuk mengautentikasi pengguna di perangkat.

acquire_user_code(resource, client_id, language=None)

Parameter

resource

str

Diperlukan

URI yang mengidentifikasi sumber daya tempat device_code dan user_code valid.

client_id

str

Diperlukan

Id klien OAuth dari aplikasi panggilan.

language

str

nilai default: None

Kode bahasa yang menentukan bagaimana pesan harus dilokalkan.

Mengembalikan

dict berisi kode dan uri bagi pengguna untuk masuk melalui browser.

cancel_request_to_get_token_with_device_code

Membatalkan permintaan polling untuk mendapatkan token dengan kode perangkat.

cancel_request_to_get_token_with_device_code(user_code_info)

Parameter

user_code_info

dict

Diperlukan

Info kode dari pemanggilan "acquire_user_code"

Mengembalikan

Tidak ada

Atribut

options