AuthorizationCodeCredential class
Permet l’authentification de Microsoft Entra ID à l’aide d’un code d’autorisation obtenu via le flux de code d’autorisation, décrit plus en détail dans la documentation Microsoft Entra ID :
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Constructeurs
| Authorization |
Crée une instance d’AuthorizationCodeCredential avec les détails nécessaires pour demander un jeton d’accès en utilisant une authentification obtenue via Microsoft Entra ID. Il est actuellement nécessaire à l’utilisateur de ces informations d’identification de lancer le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Voici un exemple complet de ce flux : |
| Authorization |
Crée une instance d’AuthorizationCodeCredential avec les détails nécessaires pour demander un jeton d’accès en utilisant une authentification obtenue via Microsoft Entra ID. Il est actuellement nécessaire à l’utilisateur de ces informations d’identification de lancer le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Voici un exemple complet de ce flux : |
Méthodes
| get |
S’authentifie avec Microsoft Entra ID et renvoie un jeton d’accès si réussit. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec. |
Détails du constructeur
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Crée une instance d’AuthorizationCodeCredential avec les détails nécessaires pour demander un jeton d’accès en utilisant une authentification obtenue via Microsoft Entra ID.
Il est actuellement nécessaire à l’utilisateur de ces informations d’identification de lancer le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Voici un exemple complet de ce flux :
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Paramètres
- tenantId
-
string
L’ID ou nom du locataire Microsoft Entra (annuaire). « common » peut être utilisé lors du traitement des scénarios multilocataires.
- clientId
-
string
ID client (application) d’une inscription d’application dans le locataire.
- authorizationCode
-
string
Code d’autorisation reçu à partir du flux de code d’autorisation suivant. Ce code d’autorisation ne doit pas avoir déjà été utilisé pour obtenir un jeton d’accès.
- redirectUri
-
string
URI de redirection utilisé pour demander le code d’autorisation. Doit être le même URI que celui configuré pour l’inscription d’application.
Options de configuration du client qui effectue la demande de jeton d’accès.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Crée une instance d’AuthorizationCodeCredential avec les détails nécessaires pour demander un jeton d’accès en utilisant une authentification obtenue via Microsoft Entra ID.
Il est actuellement nécessaire à l’utilisateur de ces informations d’identification de lancer le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Voici un exemple complet de ce flux :
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Paramètres
- tenantId
-
string
L’ID ou nom du locataire Microsoft Entra (annuaire). « common » peut être utilisé lors du traitement des scénarios multilocataires.
- clientId
-
string
ID client (application) d’une inscription d’application dans le locataire.
- clientSecret
-
string
Clé secrète client générée pour l’inscription d’application
- authorizationCode
-
string
Code d’autorisation reçu à partir du flux de code d’autorisation suivant. Ce code d’autorisation ne doit pas avoir déjà été utilisé pour obtenir un jeton d’accès.
- redirectUri
-
string
URI de redirection utilisé pour demander le code d’autorisation. Doit être le même URI que celui configuré pour l’inscription d’application.
Options de configuration du client qui effectue la demande de jeton d’accès.
Détails de la méthode
getToken(string | string[], GetTokenOptions)
S’authentifie avec Microsoft Entra ID et renvoie un jeton d’accès si réussit. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>Paramètres
- scopes
-
string | string[]
Liste des étendues auxquelles le jeton aura accès.
- options
- GetTokenOptions
Les options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.
Retours
Promise<AccessToken>