Share via

DeviceCodeCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu kodu urządzenia, który użytkownik może wprowadzić w programie https://microsoft.com/devicelogin.

Konstruktory

DeviceCodeCredential(DeviceCodeCredentialOptions)

Tworzy wystąpienie elementu DeviceCodeCredential ze szczegółami wymaganymi do zainicjowania przepływu autoryzacji kodu urządzenia za pomocą Tożsamość Microsoft Entra.

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 przez przekazanie niestandardowego userPromptCallbackelementu :

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

Metody

authenticate(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda będzie wymagać interakcji użytkownika w celu pobrania tokenu.
getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie mógł zostać pobrany w trybie dyskretnym, ta metoda nie podejmie próby zażądania interakcji z użytkownikiem w celu pobrania tokenu.

Szczegóły konstruktora

DeviceCodeCredential(DeviceCodeCredentialOptions)

Tworzy wystąpienie elementu DeviceCodeCredential ze szczegółami wymaganymi do zainicjowania przepływu autoryzacji kodu urządzenia za pomocą Tożsamość Microsoft Entra.

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 przez przekazanie niestandardowego userPromptCallbackelementu :

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: 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ę przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Jeśli nie można pobrać tokenu w trybie dyskretnym, ta metoda będzie wymagać interakcji użytkownika w celu pobrania tokenu.

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ę przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie mógł zostać pobrany w trybie dyskretnym, ta metoda nie podejmie próby zażądania interakcji z użytkownikiem 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>