InteractiveBrowserCredential الفصل

فتح مستعرض لمصادقة مستخدم بشكل تفاعلي.

get_token يفتح مستعرضا إلى عنوان URL لتسجيل الدخول الذي يوفره Azure Active Directory ويصادق مستخدما هناك مع تدفق رمز التخويل، باستخدام PKCE (مفتاح إثبات تبادل التعليمات البرمجية) داخليا لحماية التعليمات البرمجية.

توريث

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

الدالمنشئ

InteractiveBrowserCredential(**kwargs: Any)

المعلمات

authority

str

سلطة نقطة نهاية Azure Active Directory، على سبيل المثال "login.microsoftonline.com"، وهي سلطة Azure Public Cloud (وهو الافتراضي). AzureAuthorityHosts يحدد السلطات للسحب الأخرى.

tenant_id

str

معرف مستأجر Azure Active Directory. الإعدادات الافتراضية للمستأجر "المؤسسات"، والتي يمكنها مصادقة حسابات العمل أو المؤسسة التعليمية.

client_id

str

سيسجل معرف العميل لمستخدمي تطبيق Azure Active Directory الدخول إليه. إذا لم يتم تحديده، فسيصادق المستخدمون على تطبيق تطوير Azure.

login_hint

str

اقتراح اسم مستخدم لملء حقل اسم المستخدم/عنوان البريد الإلكتروني لصفحة تسجيل الدخول مسبقا. قد لا يزال المستخدم يسجل الدخول باسم مستخدم مختلف.

redirect_uri

str

عنوان URI لإعادة التوجيه للتطبيق الذي تم تحديده بواسطة client_id كما تم تكوينه في Azure Active Directory، على سبيل المثال "http://localhost:8400". هذا مطلوب فقط عند تمرير قيمة client_id، ويجب أن يتطابق مع عنوان URI لإعادة التوجيه في تسجيل التطبيق. يجب أن تكون بيانات الاعتماد قادرة على ربط مأخذ توصيل ب URI هذا.

authentication_record

AuthenticationRecord

AuthenticationRecord تم إرجاعه بواسطة authenticate

disable_automatic_authentication

bool

إذا كان True، get_token فسيتم رفعه AuthenticationRequiredError عندما يكون تفاعل المستخدم مطلوبا للحصول على رمز مميز. الإعدادات الافتراضية معينة على False.

cache_persistence_options

TokenCachePersistenceOptions

تكوين التخزين المؤقت للرمز المميز المستمر. إذا لم يتم تحديده، فستخزن بيانات الاعتماد الرموز المميزة مؤقتا في الذاكرة.

timeout

int

ثواني للانتظار حتى يكمل المستخدم المصادقة. الإعدادات الافتراضية إلى 300 (5 دقائق).

disable_instance_discovery

bool

تحديد ما إذا كان يتم تنفيذ اكتشاف المثيل أم لا عند محاولة المصادقة. سيؤدي تعيين هذا إلى true إلى تعطيل كل من اكتشاف المثيل والتحقق من صحة المرجع تماما. هذه الوظيفة مخصصة للاستخدام في السيناريوهات التي لا يمكن فيها الوصول إلى نقطة نهاية بيانات التعريف، كما هو الحال في السحب الخاصة أو Azure Stack. تتطلب عملية اكتشاف المثيل استرداد بيانات تعريف المرجع من https://login.microsoft.com/ للتحقق من صحة السلطة. من خلال تعيين هذا إلى True، يتم تعطيل التحقق من صحة المرجع. ونتيجة لذلك، من الضروري التأكد من أن مضيف المرجع المكون صالح وجدير بالثقة.

أمثلة

إنشاء InteractiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

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

الأساليب

authenticate	مصادقة مستخدم بشكل تفاعلي.
close
get_token	طلب رمز مميز للوصول للنطاقات. يتم استدعاء هذا الأسلوب تلقائيا بواسطة عملاء Azure SDK.

authenticate

مصادقة مستخدم بشكل تفاعلي.

authenticate(**kwargs: Any) -> AuthenticationRecord

المعلمات

scopes

Iterable[str]

نطاقات الطلب أثناء المصادقة، مثل تلك التي يوفرها scopes. إذا تم توفيرها، فستخزن المصادقة الناجحة رمز وصول لهذه النطاقات مؤقتا.

claims

str

المطالبات الإضافية المطلوبة في الرمز المميز، مثل تلك التي يوفرها claims

نوع الإرجاع

AuthenticationRecord

استثناءات

ClientAuthenticationError

فشلت المصادقة. تعطي سمة message الخطأ سببا.

close

close() -> None

استثناءات

ClientAuthenticationError

فشلت المصادقة. تعطي سمة message الخطأ سببا.

get_token

طلب رمز مميز للوصول للنطاقات.

يتم استدعاء هذا الأسلوب تلقائيا بواسطة عملاء Azure SDK.

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

المعلمات

scopes

str

مطلوب

النطاقات المطلوبة للرمز المميز للوصول. يتطلب هذا الأسلوب نطاقا واحدا على الأقل. لمزيد من المعلومات حول النطاقات، راجع https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

المطالبات الإضافية المطلوبة في الرمز المميز، مثل تلك التي تم إرجاعها في تحدي مطالبات موفر الموارد بعد فشل التخويل

tenant_id

str

مستأجر اختياري لتضمينه في طلب الرمز المميز.

enable_cae

bool

يشير إلى ما إذا كان يجب تمكين تقييم الوصول المستمر (CAE) للرمز المميز المطلوب. الإعدادات الافتراضية معينة على False.

المرتجعات

رمز مميز للوصول مع النطاقات المطلوبة.

نوع الإرجاع

AccessToken

استثناءات

CredentialUnavailableError

بيانات الاعتماد غير قادرة على محاولة المصادقة لأنها تفتقر إلى البيانات المطلوبة أو الحالة أو دعم النظام الأساسي

ClientAuthenticationError

فشلت المصادقة. تعطي سمة message الخطأ سببا.

AuthenticationRequiredError

يعد تفاعل المستخدم ضروريا للحصول على رمز مميز، ويتم تكوين بيانات الاعتماد لعدم بدء ذلك تلقائيا. الاتصال

authenticate

لبدء المصادقة التفاعلية.