AuthorizationCodeCredential class
Möjliggör autentisering till Microsoft Entra ID med en auktoriseringskod som erhölls via auktoriseringskodflödet, beskriven mer i detalj 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 de uppgifter som behövs för att begära en åtkomsttoken med en autentisering som erhållits 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: |
| Authorization |
Skapar en instans av AuthorizationCodeCredential med de uppgifter som behövs för att begära en åtkomsttoken med en autentisering som erhållits 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: |
Metoder
| get |
Autentisera 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 de uppgifter som behövs för att begära en åtkomsttoken med en autentisering som erhållits 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:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parametrar
- tenantId
-
string
Microsoft Entra-tenantens (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.
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 de uppgifter som behövs för att begära en åtkomsttoken med en autentisering som erhållits 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:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parametrar
- tenantId
-
string
Microsoft Entra-tenantens (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.
Alternativ för att konfigurera klienten som gör begäran om åtkomsttoken.
Metodinformation
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.
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>