DeviceCodeCredential class

Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Microsoft Entra ID za pomocą kodu urządzenia, który użytkownik może wpisać w https://microsoft.com/devicelogin.

Konstruktory

DeviceCodeCredential(DeviceCodeCredentialOptions)

Tworzy instancję DeviceCodeCredential z szczegółami potrzebnymi do rozpoczęcia procesu autoryzacji kodu urządzenia za pomocą Microsoft Entra ID.

Zostanie zarejestrowany komunikat, dając użytkownikom kod, którego mogą używać do uwierzytelniania po przejściu do https://microsoft.com/devicelogin

Deweloperzy mogą skonfigurować sposób wyświetlania tego komunikatu, przekazując niestandardowy 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);
  },
});

Metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda zawsze wygeneruje wyzwanie dla użytkownika.
getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania interakcji użytkownika w celu pobrania tokenu.

Szczegóły konstruktora

DeviceCodeCredential(DeviceCodeCredentialOptions)

Tworzy instancję DeviceCodeCredential z szczegółami potrzebnymi do rozpoczęcia procesu autoryzacji kodu urządzenia za pomocą Microsoft Entra ID.

Zostanie zarejestrowany komunikat, dając użytkownikom kod, którego mogą używać do uwierzytelniania po przejściu do https://microsoft.com/devicelogin

Deweloperzy mogą skonfigurować sposób wyświetlania tego komunikatu, przekazując niestandardowy 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)

Parametry

options
DeviceCodeCredentialOptions

Opcje konfigurowania klienta, który wysyła żądania uwierzytelniania.

Szczegóły metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda zawsze wygeneruje wyzwanie dla użytkownika.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania interakcji użytkownika w celu pobrania tokenu.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<AccessToken>