اقرأ باللغة الإنجليزية

مشاركة عبر

AuthorizationCodeCredential class

  • ‏‏المرجع
الحزمة:
@azure/identity

تمكين المصادقة إلى معرف Microsoft Entra باستخدام رمز تخويل تم الحصول عليه من خلال تدفق رمز التخويل، الموضح بمزيد من التفصيل في وثائق معرف Microsoft Entra:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

المنشئون

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

إنشاء مثيل AuthorizationCodeCredential مع التفاصيل المطلوبة لطلب رمز وصول باستخدام مصادقة تم الحصول عليها من معرف Microsoft Entra.

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

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

إنشاء مثيل AuthorizationCodeCredential مع التفاصيل المطلوبة لطلب رمز وصول باستخدام مصادقة تم الحصول عليها من معرف Microsoft Entra.

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

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

الأساليب

getToken(string | string[], GetTokenOptions)

المصادقة باستخدام معرف Microsoft Entra وإرجاع رمز مميز للوصول إذا كان ناجحا. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل.

تفاصيل المنشئ

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

إنشاء مثيل AuthorizationCodeCredential مع التفاصيل المطلوبة لطلب رمز وصول باستخدام مصادقة تم الحصول عليها من معرف Microsoft Entra.

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

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

TypeScript 
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

المعلمات

tenantId

string

معرف أو اسم مستأجر Microsoft Entra (الدليل). يمكن استخدام "شائع" عند التعامل مع سيناريوهات متعددة المستأجرين.

clientId

string

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

authorizationCode

string

رمز التخويل الذي تم تلقيه من اتباع تدفق رمز التخويل. يجب ألا يكون رمز التخويل هذا قد تم استخدامه بالفعل للحصول على رمز مميز للوصول.

redirectUri

string

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

options
AuthorizationCodeCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب الرمز المميز للوصول.

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

إنشاء مثيل AuthorizationCodeCredential مع التفاصيل المطلوبة لطلب رمز وصول باستخدام مصادقة تم الحصول عليها من معرف Microsoft Entra.

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

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

TypeScript 
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

المعلمات

tenantId

string

معرف أو اسم مستأجر Microsoft Entra (الدليل). يمكن استخدام "شائع" عند التعامل مع سيناريوهات متعددة المستأجرين.

clientId

string

معرف العميل (التطبيق) لتسجيل التطبيق في المستأجر.

clientSecret

string

سر العميل الذي تم إنشاؤه لتسجيل التطبيق

authorizationCode

string

رمز التخويل الذي تم تلقيه من اتباع تدفق رمز التخويل. يجب ألا يكون رمز التخويل هذا قد تم استخدامه بالفعل للحصول على رمز مميز للوصول.

redirectUri

string

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

options
AuthorizationCodeCredentialOptions

خيارات لتكوين العميل الذي يقوم بطلب الرمز المميز للوصول.

تفاصيل الأسلوب

getToken(string | string[], GetTokenOptions)

المصادقة باستخدام معرف Microsoft Entra وإرجاع رمز مميز للوصول إذا كان ناجحا. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل.

TypeScript 
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

المعلمات

scopes

string | string[]

قائمة النطاقات التي سيكون للرمز المميز حق الوصول إليها.

options
GetTokenOptions

الخيارات المستخدمة لتكوين أي طلبات قد يقدمها تطبيق TokenCredential هذا.

المرتجعات

Promise<AccessToken>