ClientSecretCredential class

الحزمة:

@azure/identity

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

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

المنشئون

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

إنشاء مثيل ClientSecretCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع سر العميل.

الأساليب

getToken(string | string[], GetTokenOptions)

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

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

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

إنشاء مثيل ClientSecretCredential مع التفاصيل اللازمة للمصادقة مقابل Microsoft Entra ID مع سر العميل.

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

المعلمات

tenantId

string

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

clientId

string

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

clientSecret

string

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

options

ClientSecretCredentialOptions

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

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

getToken(string | string[], GetTokenOptions)

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

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

المعلمات

scopes

string | string[]

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

options

GetTokenOptions

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

المرتجعات

Promise<AccessToken>