ClientApplication class

Classe abstraite de base pour toutes les applications clientes - public et confidentiel

Méthodes

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Acquiert un jeton en échangeant le code d’autorisation reçu à partir de la première étape du flux de code d’autorisation OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) peut être utilisé pour créer l’URL de la première étape du flux de code d’autorisation OAuth2.0. Vérifiez que les valeurs de redirectUri et d’étendues dans AuthorizationCodeUrlRequest et AuthorizationCodeRequest sont identiques.

acquireTokenByRefreshToken(RefreshTokenRequest)

Acquiert un jeton en échangeant le jeton d’actualisation fourni pour un nouvel ensemble de jetons.

Cette API est fournie uniquement pour les scénarios où vous souhaitez migrer de la bibliothèque ADAL vers MSAL. Sinon, il est recommandé d’utiliser acquireTokenSilent() pour les scénarios silencieux. Lors de l’utilisation acquireTokenSilent(), MSAL gère automatiquement la mise en cache et l’actualisation des jetons.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Acquiert des jetons avec l’octroi de mot de passe en échangeant le nom d’utilisateur et le mot de passe des applications clientes pour les informations d’identification

La dernière pratique actuelle de sécurité OAuth 2.0 interdit entièrement l’octroi de mot de passe. Pour plus d'informations sur cette recommandation, consultez la https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 documentation et les recommandations de Microsoft :https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Acquiert un jeton en mode silencieux lorsqu’un utilisateur spécifie le compte pour lequel le jeton est demandé.

Cette API s’attend à ce que l’utilisateur fournisse un objet de compte et examine le cache pour récupérer le jeton s’il est présent. Il existe également une valeur booléenne « forceRefresh » facultative que l’utilisateur peut envoyer pour contourner le cache pour access_token et id_token. Si le refresh_token a expiré ou n’est pas trouvé, une erreur est levée et les instructions sont destinées à l’utilisateur à appeler une API d’acquisition de jeton interactive (par exemple : acquireTokenByCode()).

clearCache()

Effacer le cache

getAuthCodeUrl(AuthorizationUrlRequest)

Crée l’URL de la demande d’autorisation, permettant à l’utilisateur d’entrer les informations d’identification et de donner son consentement à l’application. L’URL cible le point de terminaison /authorize de l’autorité configurée dans l’objet d’application.

Une fois que l’utilisateur entre ses informations d’identification et son consentement, l’autorité envoie une réponse à l’URI de redirection envoyé dans la demande et doit contenir un code d’autorisation, qui peut ensuite être utilisé pour acquérir des jetons via acquireTokenByCode(AuthorizationCodeRequest).

getLogger()

Retourne l’instance de l’enregistreur d’événements

getTokenCache()

Obtient le cache de jetons de l’application.

setLogger(Logger)

Remplace le jeu d’événements par défaut dans les configurations par le nouvel enregistreur d’événements par de nouvelles configurations

Détails de la méthode

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Acquiert un jeton en échangeant le code d’autorisation reçu à partir de la première étape du flux de code d’autorisation OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) peut être utilisé pour créer l’URL de la première étape du flux de code d’autorisation OAuth2.0. Vérifiez que les valeurs de redirectUri et d’étendues dans AuthorizationCodeUrlRequest et AuthorizationCodeRequest sont identiques.

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

Paramètres

authCodePayLoad
AuthorizationCodePayload

Retours

acquireTokenByRefreshToken(RefreshTokenRequest)

Acquiert un jeton en échangeant le jeton d’actualisation fourni pour un nouvel ensemble de jetons.

Cette API est fournie uniquement pour les scénarios où vous souhaitez migrer de la bibliothèque ADAL vers MSAL. Sinon, il est recommandé d’utiliser acquireTokenSilent() pour les scénarios silencieux. Lors de l’utilisation acquireTokenSilent(), MSAL gère automatiquement la mise en cache et l’actualisation des jetons.

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Paramètres

Retours

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Avertissement

Cette API est à présent déconseillée.

  • Use a more secure flow instead

Acquiert des jetons avec l’octroi de mot de passe en échangeant le nom d’utilisateur et le mot de passe des applications clientes pour les informations d’identification

La dernière pratique actuelle de sécurité OAuth 2.0 interdit entièrement l’octroi de mot de passe. Pour plus d'informations sur cette recommandation, consultez la https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 documentation et les recommandations de Microsoft :https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Paramètres

request
UsernamePasswordRequest

UsenamePasswordRequest

Retours

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Acquiert un jeton en mode silencieux lorsqu’un utilisateur spécifie le compte pour lequel le jeton est demandé.

Cette API s’attend à ce que l’utilisateur fournisse un objet de compte et examine le cache pour récupérer le jeton s’il est présent. Il existe également une valeur booléenne « forceRefresh » facultative que l’utilisateur peut envoyer pour contourner le cache pour access_token et id_token. Si le refresh_token a expiré ou n’est pas trouvé, une erreur est levée et les instructions sont destinées à l’utilisateur à appeler une API d’acquisition de jeton interactive (par exemple : acquireTokenByCode()).

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Paramètres

Retours

clearCache()

Effacer le cache

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Crée l’URL de la demande d’autorisation, permettant à l’utilisateur d’entrer les informations d’identification et de donner son consentement à l’application. L’URL cible le point de terminaison /authorize de l’autorité configurée dans l’objet d’application.

Une fois que l’utilisateur entre ses informations d’identification et son consentement, l’autorité envoie une réponse à l’URI de redirection envoyé dans la demande et doit contenir un code d’autorisation, qui peut ensuite être utilisé pour acquérir des jetons via acquireTokenByCode(AuthorizationCodeRequest).

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Paramètres

Retours

Promise<string>

getLogger()

Retourne l’instance de l’enregistreur d’événements

function getLogger(): Logger

Retours

getTokenCache()

Obtient le cache de jetons de l’application.

function getTokenCache(): TokenCache

Retours

setLogger(Logger)

Remplace le jeu d’événements par défaut dans les configurations par le nouvel enregistreur d’événements par de nouvelles configurations

function setLogger(logger: Logger)

Paramètres

logger
Logger

Instance d’enregistreur d’événements