مشاركة عبر

AuthorizationCodeCredential الفصل

  • ‏‏المرجع

المصادقة عن طريق استرداد رمز تخويل تم الحصول عليه مسبقا من Azure Active Directory.

راجع وثائق Azure Active Directory لمزيد من المعلومات حول تدفق المصادقة.

توريث
azure.identity._internal.get_token_mixin.GetTokenMixin
AuthorizationCodeCredential

الدالمنشئ

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

المعلمات

tenant_id
str
مطلوب

معرف مستأجر Azure Active Directory للتطبيق. يسمى أيضا معرف "الدليل" الخاص به.

client_id
str
مطلوب

معرف عميل التطبيق

authorization_code
str
مطلوب

رمز التخويل من تسجيل دخول المستخدم

redirect_uri
str
مطلوب

عنوان URI لإعادة توجيه التطبيق. يجب أن يتطابق مع URI المستخدم لطلب رمز التخويل.

authority
str

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

client_secret
str

أحد أسرار عميل التطبيق. مطلوب فقط لتطبيقات الويب وواجهات برمجة تطبيقات الويب.

additionally_allowed_tenants
List[str]

يحدد المستأجرين بالإضافة إلى "tenant_id" المحدد الذي قد تحصل بيانات الاعتماد على رموز مميزة له. أضف قيمة حرف البدل "*" للسماح لبيانات الاعتماد بالحصول على رموز مميزة لأي مستأجر يمكن للتطبيق الوصول إليه.

أمثلة

إنشاء AuthorizationCodeCredential.


   from azure.identity import AuthorizationCodeCredential

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

الأساليب

close

أغلق جلسة نقل بيانات الاعتماد.
get_token

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

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

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

close

أغلق جلسة نقل بيانات الاعتماد.

close() -> None

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

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

المرتجعات

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

نوع الإرجاع

AccessToken

استثناءات

ClientAuthenticationError

فشلت المصادقة. تعطي سمة message الخطأ سببا. تتوفر أي استجابة خطأ من Azure Active Directory كسمة response الخطأ.