AuthorizationCodeCredential class
Gör att autentisering kan Microsoft Entra ID med hjälp av en auktoriseringskod som erhölls via auktoriseringskodflödet, som beskrivs mer detaljerat i Microsoft Entra ID dokumentationen:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Konstruktorer
| Authorization |
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 få en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här: |
| Authorization |
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 få en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här: |
Metoder
| get |
Autentiserar med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas genereras 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 få en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parametrar
- tenantId
-
string
ID:t eller namnet på Microsoft Entra klientorganisation (katalog). "vanliga" kan användas när du hanterar scenarier med flera klientorganisationer.
- clientId
-
string
Klient-ID för en appregistrering i klientorganisationen.
- authorizationCode
-
string
En auktoriseringskod som togs emot från att följa auktoriseringskodflödet. Den här auktoriseringskoden får inte redan ha använts för att hämta en åtkomsttoken.
- redirectUri
-
string
Omdirigerings-URI:n som användes för att begära auktoriseringskoden. Måste vara samma URI som har konfigurerats för appregistreringen.
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 få en auktoriseringskod som ska användas med den här autentiseringsuppgiften. Ett fullständigt exempel på det här flödet finns här:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parametrar
- tenantId
-
string
ID:t eller namnet på Microsoft Entra klientorganisation (katalog). "vanliga" kan användas när du hanterar scenarier med flera klientorganisationer.
- clientId
-
string
Klient-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 att följa auktoriseringskodflödet. Den här auktoriseringskoden får inte redan ha använts för att hämta en åtkomsttoken.
- redirectUri
-
string
Omdirigerings-URI:n som användes för att begära auktoriseringskoden. Måste vara samma URI som har konfigurerats för appregistreringen.
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 genereras 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 tokencredential-implementeringen kan göra.
Returer
Promise<AccessToken>