Sdílet prostřednictvím

DeviceCodeCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování pro Microsoft Entra ID pomocí kódu zařízení, který uživatel může zadat do https://microsoft.com/devicelogin.

Konstruktory

DeviceCodeCredential(DeviceCodeCredentialOptions)

Vytvoří instanci DeviceCodeCredential s podrobnostmi potřebnými k zahájení toku autorizace kódu zařízení s ID Microsoft Entra.

Zpráva se zaprotokoluje a uživatelům poskytne kód, který můžou použít k ověření, jakmile přejdou na https://microsoft.com/devicelogin

Vývojáři můžou nakonfigurovat způsob zobrazení této zprávy předáním vlastního 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)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Pokud token nelze načíst bezobslužně, tato metoda vždy vygeneruje výzvu pro uživatele.
getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Pokud uživatel zadal možnost disableAutomaticAuthentication, jakmile token nelze načíst bezobslužně, tato metoda se nepokusí požádat o interakci uživatele k načtení tokenu.

Podrobnosti konstruktoru

DeviceCodeCredential(DeviceCodeCredentialOptions)

Vytvoří instanci DeviceCodeCredential s podrobnostmi potřebnými k zahájení toku autorizace kódu zařízení s ID Microsoft Entra.

Zpráva se zaprotokoluje a uživatelům poskytne kód, který můžou použít k ověření, jakmile přejdou na https://microsoft.com/devicelogin

Vývojáři můžou nakonfigurovat způsob zobrazení této zprávy předáním vlastního 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

Možnosti konfigurace klienta, který provádí žádosti o ověření

Podrobnosti metody

authenticate(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Pokud token nelze načíst bezobslužně, tato metoda vždy vygeneruje výzvu pro uživatele.

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

Parametry

scopes

string | string[]

Seznam oborů, pro které bude mít token přístup.

options
GetTokenOptions

Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.

Návraty

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Pokud uživatel zadal možnost disableAutomaticAuthentication, jakmile token nelze načíst bezobslužně, tato metoda se nepokusí požádat o interakci uživatele k načtení tokenu.

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

Parametry

scopes

string | string[]

Seznam oborů, pro které bude mít token přístup.

options
GetTokenOptions

Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.

Návraty

Promise<AccessToken>