DeviceCodeCredential class

Möjliggör autentisering för att Microsoft Entra ID med en enhetskod som användaren kan mata in i https://microsoft.com/devicelogin.

Konstruktorer

DeviceCodeCredential(DeviceCodeCredentialOptions)

Skapar en instans av DeviceCodeCredential med de detaljer som behövs för att initiera enhetskodens auktoriseringsflöde med Microsoft Entra ID.

Ett meddelande loggas, vilket ger användarna en kod som de kan använda för att autentisera när de går till https://microsoft.com/devicelogin

Utvecklare kan konfigurera hur det här meddelandet visas genom att skicka en anpassad 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);
  },
});

Metoder

authenticate(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Om token inte kan hämtas tyst genererar den här metoden alltid en utmaning för användaren.

getToken(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Om användaren angav alternativet disableAutomaticAuthentication, när token inte kan hämtas tyst, kommer den här metoden inte att försöka begära användarinteraktion för att hämta token.

Konstruktorinformation

DeviceCodeCredential(DeviceCodeCredentialOptions)

Skapar en instans av DeviceCodeCredential med de detaljer som behövs för att initiera enhetskodens auktoriseringsflöde med Microsoft Entra ID.

Ett meddelande loggas, vilket ger användarna en kod som de kan använda för att autentisera när de går till https://microsoft.com/devicelogin

Utvecklare kan konfigurera hur det här meddelandet visas genom att skicka en anpassad 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)

Parametrar

options
DeviceCodeCredentialOptions

Alternativ för att konfigurera klienten som gör autentiseringsbegäranden.

Metodinformation

authenticate(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Om token inte kan hämtas tyst genererar den här metoden alltid en utmaning för användaren.

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

Parametrar

scopes

string | string[]

Listan över omfång som token ska ha åtkomst till.

options
GetTokenOptions

De alternativ som används för att konfigurera alla begäranden som denna TokenCredential-implementering kan göra.

Returer

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Om användaren angav alternativet disableAutomaticAuthentication, när token inte kan hämtas tyst, kommer den här metoden inte att försöka begära användarinteraktion för att hämta token.

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

Parametrar

scopes

string | string[]

Listan över omfång som token ska ha åtkomst till.

options
GetTokenOptions

De alternativ som används för att konfigurera alla begäranden som denna TokenCredential-implementering kan göra.

Returer

Promise<AccessToken>