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 à l’aide d’une authentification obtenue à partir de Microsoft Entra ID. Il est actuellement nécessaire que l’utilisateur de ces informations d’identification lance le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Un exemple complet de ce flux est fourni ici : |
Authorization |
Crée une instance d’AuthorizationCodeCredential avec les détails nécessaires pour demander un jeton d’accès à l’aide d’une authentification obtenue à partir de Microsoft Entra ID. Il est actuellement nécessaire que l’utilisateur de ces informations d’identification lance le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Un exemple complet de ce flux est fourni ici : |
Méthodes
get |
S’authentifie avec Microsoft Entra ID et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une erreur 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 à l’aide d’une authentification obtenue à partir de Microsoft Entra ID.
Il est actuellement nécessaire que l’utilisateur de ces informations d’identification lance le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Un exemple complet de ce flux est fourni ici :
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Paramètres
- tenantId
-
string
ID ou nom du locataire (répertoire) Microsoft Entra. « common » peut être utilisé lors de la gestion de scénarios multilocataires.
- clientId
-
string
ID client (application) d’une inscription d’application dans le locataire.
- authorizationCode
-
string
Code d’autorisation qui a été reçu à partir du flux de code d’autorisation. 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 à l’aide d’une authentification obtenue à partir de Microsoft Entra ID.
Il est actuellement nécessaire que l’utilisateur de ces informations d’identification lance le flux de code d’autorisation pour obtenir un code d’autorisation à utiliser avec ces informations d’identification. Un exemple complet de ce flux est fourni ici :
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Paramètres
- tenantId
-
string
ID ou nom du locataire (répertoire) Microsoft Entra. « common » peut être utilisé lors de la gestion de scénarios multilocataires.
- clientId
-
string
ID client (application) d’une inscription d’application dans le locataire.
- clientSecret
-
string
Clé secrète client qui a été générée pour l’inscription de l’application
- authorizationCode
-
string
Code d’autorisation qui a été reçu à partir du flux de code d’autorisation. 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 retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une erreur 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
Options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.
Retours
Promise<AccessToken>