مشاركة عبر

DeviceCodeCredential class

الحزمة:
@azure/identity

تمكين المصادقة إلى معرف Microsoft Entra باستخدام رمز جهاز يمكن للمستخدم إدخاله في https://microsoft.com/devicelogin.

المنشئون

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

سيتم تسجيل رسالة، مما يمنح المستخدمين رمزا يمكنهم استخدامه للمصادقة بمجرد انتقالهم إلى https://microsoft.com/devicelogin

يمكن للمطورين تكوين كيفية عرض هذه الرسالة عن طريق تمرير userPromptCallbackمخصص :

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

الأساليب

authenticate(string | string[], GetTokenOptions)

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

إذا تعذر استرداد الرمز المميز بصمت، فإن هذه الطريقة ستنشئ دائما تحديا للمستخدم.
getToken(string | string[], GetTokenOptions)

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

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

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

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

سيتم تسجيل رسالة، مما يمنح المستخدمين رمزا يمكنهم استخدامه للمصادقة بمجرد انتقالهم إلى https://microsoft.com/devicelogin

يمكن للمطورين تكوين كيفية عرض هذه الرسالة عن طريق تمرير userPromptCallbackمخصص :

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

المعلمات

options
DeviceCodeCredentialOptions

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

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

authenticate(string | string[], GetTokenOptions)

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

إذا تعذر استرداد الرمز المميز بصمت، فإن هذه الطريقة ستنشئ دائما تحديا للمستخدم.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

المعلمات

scopes

string | string[]

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

options
GetTokenOptions

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

المرتجعات

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

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

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

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

المعلمات

scopes

string | string[]

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

options
GetTokenOptions

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

المرتجعات

Promise<AccessToken>