Megosztás:

DeviceCodeCredential class

Csomag:
@azure/identity

Engedélyezi a Microsoft Entra ID-hitelesítést egy olyan eszközkód használatával, amelyet a felhasználó be tud írni https://microsoft.com/devicelogin.

Konstruktorok

DeviceCodeCredential(DeviceCodeCredentialOptions)

Létrehoz egy DeviceCodeCredential-példányt az eszközkód engedélyezési folyamatának a Microsoft Entra-azonosítóval való elindításához szükséges részletekkel.

A rendszer naplózni fog egy üzenetet, amely egy olyan kódot ad a felhasználóknak, amelyet a hitelesítéshez használhatnak a https://microsoft.com/devicelogin

A fejlesztők egyéni userPromptCallbackátadva konfigurálhatják az üzenet megjeleníthető módját:

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);
  },
});

Metódusok

authenticate(string | string[], GetTokenOptions)

Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

Ha a jogkivonat nem kérhető le csendben, ez a módszer mindig kihívást jelent a felhasználó számára.
getToken(string | string[], GetTokenOptions)

Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

Ha a felhasználó megadta a disableAutomaticAuthenticationlehetőséget, ha a jogkivonat nem kérhető le csendben, ez a módszer nem kísérli meg a felhasználói beavatkozást a jogkivonat lekéréséhez.

Konstruktor adatai

DeviceCodeCredential(DeviceCodeCredentialOptions)

Létrehoz egy DeviceCodeCredential-példányt az eszközkód engedélyezési folyamatának a Microsoft Entra-azonosítóval való elindításához szükséges részletekkel.

A rendszer naplózni fog egy üzenetet, amely egy olyan kódot ad a felhasználóknak, amelyet a hitelesítéshez használhatnak a https://microsoft.com/devicelogin

A fejlesztők egyéni userPromptCallbackátadva konfigurálhatják az üzenet megjeleníthető módját:

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)

Paraméterek

options
DeviceCodeCredentialOptions

A hitelesítési kéréseket küldő ügyfél konfigurálásának beállításai.

Metódus adatai

authenticate(string | string[], GetTokenOptions)

Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

Ha a jogkivonat nem kérhető le csendben, ez a módszer mindig kihívást jelent a felhasználó számára.

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

Paraméterek

scopes

string | string[]

Azon hatókörök listája, amelyekhez a jogkivonatnak hozzáférése lesz.

options
GetTokenOptions

A TokenCredential implementáció által küldött kérések konfigurálásához használt beállítások.

Válaszok

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Hitelesít a Microsoft Entra-azonosítóval, és sikeres esetben egy hozzáférési jogkivonatot ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

Ha a felhasználó megadta a disableAutomaticAuthenticationlehetőséget, ha a jogkivonat nem kérhető le csendben, ez a módszer nem kísérli meg a felhasználói beavatkozást a jogkivonat lekéréséhez.

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

Paraméterek

scopes

string | string[]

Azon hatókörök listája, amelyekhez a jogkivonatnak hozzáférése lesz.

options
GetTokenOptions

A TokenCredential implementáció által küldött kérések konfigurálásához használt beállítások.

Válaszok

Promise<AccessToken>