Office.AuthOptions interface

Paquet:

office

Fournit des options pour l’expérience utilisateur quand Office obtient un jeton d’accès au complément à partir d’AAD v. 2.0 avec la getAccessToken méthode .

Propriétés

allowConsentPrompt	Permet à Office d’obtenir un jeton d’accès en mode silencieux ou via un consentement interactif, si nécessaire. La valeur par défaut est false. S’il falseest défini sur , Office tente en mode silencieux d’obtenir un jeton d’accès. En cas d’échec, Office renvoie une erreur descriptive. S’il trueest défini sur , Office affiche une interface utilisateur de consentement interactif après l’échec de l’obtention silencieuse d’un jeton d’accès. L’invite autorise uniquement le consentement à l’étendue du profil AAD, et non à aucune étendue Microsoft Graph.
allowSignInPrompt	Permet à Office d’obtenir un jeton d’accès fourni en mode silencieux ou d’afficher l’interface utilisateur interactive pour connecter l’utilisateur. La valeur par défaut est false. S’il falseest défini sur , Office tente en mode silencieux d’obtenir un jeton d’accès. En cas d’échec, Office renvoie une erreur descriptive. Si la valeur trueest , Office affiche une interface utilisateur de connexion interactive après l’échec de l’obtention silencieuse d’un jeton d’accès.
asyncContext	Élément défini par l’utilisateur de tout type retourné, inchangé, dans la asyncContext propriété de l’objet AsyncResult passé à un rappel.
authChallenge	Force Office à inviter l’utilisateur à fournir le facteur supplémentaire lorsque la location ciblée par Microsoft Graph nécessite une authentification multifacteur. La valeur de chaîne identifie le type de facteur supplémentaire requis. Dans la plupart des cas, vous ne savez pas au moment du développement si le locataire de l’utilisateur nécessite un facteur supplémentaire ou ce que doit être la chaîne. Cette option est donc utilisée dans un appel « second essai » de getAccessToken après que Microsoft Graph a envoyé une erreur demandant le facteur supplémentaire et contenant la chaîne qui doit être utilisée avec l’option authChallenge .
forceAddAccount	Invite l’utilisateur à ajouter son compte Office (ou à basculer vers celui-ci, s’il est déjà ajouté). La valeur par défaut est false. Avertissement : forceAddAccount a été déconseillé. Utilisez allowSignInPrompt à la place.
forceConsent	Oblige Office à afficher l’expérience du consentement pour le complément. Cette option est utile si les autorisations Azure du complément ont été modifiées ou si le consentement de l’utilisateur a été révoqué. La valeur par défaut est false. Avertissement : forceConsent a été déconseillé. Utilisez allowConsentPrompt à la place.
forMSGraphAccess	Entraîne le renvoi d’une erreur descriptive par Office lorsque le complément souhaite accéder à Microsoft Graph et que l’utilisateur/l’administrateur n’a pas accordé son consentement aux étendues Graph. La valeur par défaut est false. Office prend en charge le consentement aux étendues Graph uniquement lorsque le complément a été déployé par un administrateur client. La définition de true cette option sur amène Office à informer votre complément au préalable (en retournant une erreur descriptive) si l’accès à Graph échoue.

Détails de la propriété

allowConsentPrompt

Permet à Office d’obtenir un jeton d’accès en mode silencieux ou via un consentement interactif, si nécessaire. La valeur par défaut est false. S’il falseest défini sur , Office tente en mode silencieux d’obtenir un jeton d’accès. En cas d’échec, Office renvoie une erreur descriptive. S’il trueest défini sur , Office affiche une interface utilisateur de consentement interactif après l’échec de l’obtention silencieuse d’un jeton d’accès. L’invite autorise uniquement le consentement à l’étendue du profil AAD, et non à aucune étendue Microsoft Graph.

allowConsentPrompt?: boolean;

Valeur de propriété

boolean

allowSignInPrompt

Permet à Office d’obtenir un jeton d’accès fourni en mode silencieux ou d’afficher l’interface utilisateur interactive pour connecter l’utilisateur. La valeur par défaut est false. S’il falseest défini sur , Office tente en mode silencieux d’obtenir un jeton d’accès. En cas d’échec, Office renvoie une erreur descriptive. Si la valeur trueest , Office affiche une interface utilisateur de connexion interactive après l’échec de l’obtention silencieuse d’un jeton d’accès.

allowSignInPrompt?: boolean;

Valeur de propriété

boolean

asyncContext

Élément défini par l’utilisateur de tout type retourné, inchangé, dans la asyncContext propriété de l’objet AsyncResult passé à un rappel.

asyncContext?: any;

Valeur de propriété

any

authChallenge

Force Office à inviter l’utilisateur à fournir le facteur supplémentaire lorsque la location ciblée par Microsoft Graph nécessite une authentification multifacteur. La valeur de chaîne identifie le type de facteur supplémentaire requis. Dans la plupart des cas, vous ne savez pas au moment du développement si le locataire de l’utilisateur nécessite un facteur supplémentaire ou ce que doit être la chaîne. Cette option est donc utilisée dans un appel « second essai » de getAccessToken après que Microsoft Graph a envoyé une erreur demandant le facteur supplémentaire et contenant la chaîne qui doit être utilisée avec l’option authChallenge .

authChallenge?: string;

Valeur de propriété

string

forceAddAccount

Avertissement

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

Use allowSignInPrompt instead.

Invite l’utilisateur à ajouter son compte Office (ou à basculer vers celui-ci, s’il est déjà ajouté). La valeur par défaut est false.

Avertissement : forceAddAccount a été déconseillé. Utilisez allowSignInPrompt à la place.

forceAddAccount?: boolean;

Valeur de propriété

boolean

forceConsent

Avertissement

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

Use allowConsentPrompt instead.

Oblige Office à afficher l’expérience du consentement pour le complément. Cette option est utile si les autorisations Azure du complément ont été modifiées ou si le consentement de l’utilisateur a été révoqué. La valeur par défaut est false.

Avertissement : forceConsent a été déconseillé. Utilisez allowConsentPrompt à la place.

forceConsent?: boolean;

Valeur de propriété

boolean

forMSGraphAccess

Entraîne le renvoi d’une erreur descriptive par Office lorsque le complément souhaite accéder à Microsoft Graph et que l’utilisateur/l’administrateur n’a pas accordé son consentement aux étendues Graph. La valeur par défaut est false. Office prend en charge le consentement aux étendues Graph uniquement lorsque le complément a été déployé par un administrateur client. La définition de true cette option sur amène Office à informer votre complément au préalable (en retournant une erreur descriptive) si l’accès à Graph échoue.

forMSGraphAccess?: boolean;

Valeur de propriété

boolean

Remarques

Remarque : Si vous développez un complément Outlook qui utilise l’authentification unique (SSO), commentez l’option forMSGraphAccess avant de charger la version test du complément à des fins de test. Sinon, vous recevrez l’erreur 13012. Pour obtenir des conseils supplémentaires, voir Détails sur l’authentification unique avec un complément Outlook.