UsernamePasswordCredential class

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.

يتيح المصادقة إلى Microsoft Entra ID باستخدام اسم المستخدم وكلمة المرور الخاصة بالمستخدم. تتطلب بيانات الاعتماد هذه درجة عالية من الثقة، لذا يجب عليك استخدامها فقط عندما لا يمكن استخدام أنواع بيانات اعتماد أخرى أكثر أمانا.

المنشئون

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

ينشئ نسخة من UsernamePasswordCredential يحتوي على التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID باستخدام اسم مستخدم وكلمة مرور.

الأساليب

getToken(string | string[], GetTokenOptions)

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

إذا قدم المستخدم الخيار disableAutomaticAuthentication، بمجرد تعذر استرداد الرمز المميز بصمت، فلن يحاول هذا الأسلوب طلب تفاعل المستخدم لاسترداد الرمز المميز.

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

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

ينشئ نسخة من UsernamePasswordCredential يحتوي على التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID باستخدام اسم مستخدم وكلمة مرور.

new UsernamePasswordCredential(tenantId: string, clientId: string, username: string, password: string, options?: UsernamePasswordCredentialOptions)

المعلمات

tenantId

string

مستأجر Microsoft Entra (الدليل).

clientId

string

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

username

string

عنوان البريد الإلكتروني لحساب المستخدم (اسم المستخدم).

password

string

كلمة مرور حساب المستخدم

options
UsernamePasswordCredentialOptions

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

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

getToken(string | string[], GetTokenOptions)

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

إذا قدم المستخدم الخيار disableAutomaticAuthentication، بمجرد تعذر استرداد الرمز المميز بصمت، فلن يحاول هذا الأسلوب طلب تفاعل المستخدم لاسترداد الرمز المميز.

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

المعلمات

scopes

string | string[]

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

options
GetTokenOptions

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

المرتجعات

Promise<AccessToken>