AuthorizationCodeCredential class

Paket:

@azure/identity

Aktiverar autentisering till Microsoft Entra-ID med hjälp av en auktoriseringskod som erhölls via auktoriseringskodflödet, som beskrivs mer detaljerat i Dokumentationen om Microsoft Entra-ID:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Konstruktorer

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Skapar en instans av AuthorizationCodeCredential med den information som behövs för att begära en åtkomsttoken med hjälp av en autentisering som hämtades från Microsoft Entra-ID. Det är för närvarande nödvändigt för användaren av den här autentiseringsuppgiften att initiera auktoriseringskodflödet för att hämta en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Skapar en instans av AuthorizationCodeCredential med den information som behövs för att begära en åtkomsttoken med hjälp av en autentisering som hämtades från Microsoft Entra-ID. Det är för närvarande nödvändigt för användaren av den här autentiseringsuppgiften att initiera auktoriseringskodflödet för att hämta en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

Metoder

getToken(string | string[], GetTokenOptions)

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

Konstruktorinformation

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Skapar en instans av AuthorizationCodeCredential med den information som behövs för att begära en åtkomsttoken med hjälp av en autentisering som hämtades från Microsoft Entra-ID.

Det är för närvarande nödvändigt för användaren av den här autentiseringsuppgiften att initiera auktoriseringskodflödet för att hämta en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametrar

tenantId

string

Microsoft Entra-klientorganisationens (katalog) ID eller namn. "common" kan användas vid hantering av scenarier med flera klientorganisationer.

clientId

string

Klientens (programmets) ID för en appregistrering i klientorganisationen.

authorizationCode

string

En auktoriseringskod som togs emot från efter auktoriseringskodflödet. Den här auktoriseringskoden får inte redan ha använts för att hämta en åtkomsttoken.

redirectUri

string

Den omdirigerings-URI som användes för att begära auktoriseringskoden. Måste vara samma URI som har konfigurerats för appregistreringen.

options

AuthorizationCodeCredentialOptions

Alternativ för att konfigurera klienten som gör begäran om åtkomsttoken.

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Skapar en instans av AuthorizationCodeCredential med den information som behövs för att begära en åtkomsttoken med hjälp av en autentisering som hämtades från Microsoft Entra-ID.

Det är för närvarande nödvändigt för användaren av den här autentiseringsuppgiften att initiera auktoriseringskodflödet för att hämta en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametrar

tenantId

string

Microsoft Entra-klientorganisationens (katalog) ID eller namn. "common" kan användas vid hantering av scenarier med flera klientorganisationer.

clientId

string

Klientens (programmets) ID för en appregistrering i klientorganisationen.

clientSecret

string

En klienthemlighet som genererades för appregistreringen

authorizationCode

string

En auktoriseringskod som togs emot från efter auktoriseringskodflödet. Den här auktoriseringskoden får inte redan ha använts för att hämta en åtkomsttoken.

redirectUri

string

Den omdirigerings-URI som användes för att begära auktoriseringskoden. Måste vara samma URI som har konfigurerats för appregistreringen.

options

AuthorizationCodeCredentialOptions

Alternativ för att konfigurera klienten som gör begäran om åtkomsttoken.

Metodinformation

getToken(string | string[], GetTokenOptions)

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

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>