OfficeRuntime.AuthOptions interface

Paquete:
office-runtime

Advertencia

Esta API ya está en desuso.

Use the Office.AuthOptions interface instead.

Proporciona opciones para la experiencia del usuario cuando Office obtiene un token de acceso al complemento de AAD v. 2.0 con el getAccessToken método.

Comentarios

Los métodos de esta interfaz son equivalentes a los de la Office.AuthOptions interfaz. Si se agregan nuevos tipos de autenticación en el futuro, solo se agregarán a la Office.AuthOptions interfaz. Para simplificar, los ejemplos de código a lo largo de la documentación usan Office.AuthOptions.

Usada por

Ejemplos

const options: OfficeRuntime.AuthOptions = {
  allowSignInPrompt: true,
  allowConsentPrompt: true,
  forMSGraphAccess: true,
};
const accessToken = await OfficeRuntime.auth.getAccessToken(options);

Propiedades

allowConsentPrompt

Permite a Office obtener un token de acceso de forma silenciosa o mediante consentimiento interactivo, si es necesario. El valor predeterminado es false. Si se establece en false, Office intentará obtener un token de acceso de forma silenciosa. Si no lo hace, Office devolverá un error descriptivo. Si se establece en true, Office mostrará una interfaz de usuario de consentimiento interactiva después de que no pueda obtener un token de acceso de forma silenciosa. El mensaje solo permitirá el consentimiento en el ámbito del perfil de AAD, no en ningún ámbito de Microsoft Graph.
allowSignInPrompt

Permite a Office obtener un token de acceso proporcionado de forma silenciosa si el consentimiento está presente o mostrar una interfaz de usuario interactiva para iniciar sesión con el usuario. El valor predeterminado es false. Si se establece en false, Office intentará obtener un token de acceso de forma silenciosa. Si no lo hace, Office devolverá un error descriptivo. Si se establece en true, Office mostrará una interfaz de usuario de inicio de sesión interactiva después de que no pueda obtener un token de acceso de forma silenciosa.
asyncContext

Un elemento definido por el AsyncResult usuario de cualquier tipo que se devuelve, sin cambios, en la asyncContext propiedad del objeto que se pasa a una devolución de llamada.
authChallenge

Hace que Office pida al usuario que proporcione el factor adicional cuando el inquilino al que se dirige Microsoft Graph requiere autenticación multifactor. El valor de cadena identifica el tipo de factor adicional que se requiere. En la mayoría de los casos, no sabrá en tiempo de desarrollo si el inquilino del usuario requiere un factor adicional o cuál debe ser la cadena. Por lo tanto, esta opción se usaría en una llamada de "segundo intento" o después de getAccessToken que Microsoft Graph haya enviado un error solicitando el factor adicional y conteniendo la cadena que se debe usar con la authChallenge opción.
forceAddAccount

Consultas al usuario que agregue su cuenta de Office (o que cambie a ella, si ya está agregada). El valor predeterminado es false.
forceConsent

Hace que Office muestre la experiencia de consentimiento del complemento. Es útil si los permisos de Azure del complemento han cambiado o si se ha revocado el consentimiento del usuario. El valor predeterminado es false.
forMSGraphAccess

Hace que Office devuelva un error descriptivo cuando el complemento quiere acceder a Microsoft Graph y el usuario o administrador no ha concedido consentimiento a los ámbitos de Graph. El valor predeterminado es false. Office solo admite el consentimiento para ámbitos de Graph cuando un administrador de inquilinos ha implementado el complemento. Si establece esta opción en true hará que Office informe al complemento de antemano (devolviendo un error descriptivo) si se producirá un error en el acceso a Graph.

Detalles de las propiedades

allowConsentPrompt

Permite a Office obtener un token de acceso de forma silenciosa o mediante consentimiento interactivo, si es necesario. El valor predeterminado es false. Si se establece en false, Office intentará obtener un token de acceso de forma silenciosa. Si no lo hace, Office devolverá un error descriptivo. Si se establece en true, Office mostrará una interfaz de usuario de consentimiento interactiva después de que no pueda obtener un token de acceso de forma silenciosa. El mensaje solo permitirá el consentimiento en el ámbito del perfil de AAD, no en ningún ámbito de Microsoft Graph.

allowConsentPrompt?: boolean;

Valor de propiedad

boolean

allowSignInPrompt

Permite a Office obtener un token de acceso proporcionado de forma silenciosa si el consentimiento está presente o mostrar una interfaz de usuario interactiva para iniciar sesión con el usuario. El valor predeterminado es false. Si se establece en false, Office intentará obtener un token de acceso de forma silenciosa. Si no lo hace, Office devolverá un error descriptivo. Si se establece en true, Office mostrará una interfaz de usuario de inicio de sesión interactiva después de que no pueda obtener un token de acceso de forma silenciosa.

allowSignInPrompt?: boolean;

Valor de propiedad

boolean

asyncContext

Un elemento definido por el AsyncResult usuario de cualquier tipo que se devuelve, sin cambios, en la asyncContext propiedad del objeto que se pasa a una devolución de llamada.

asyncContext?: any;

Valor de propiedad

any

authChallenge

Hace que Office pida al usuario que proporcione el factor adicional cuando el inquilino al que se dirige Microsoft Graph requiere autenticación multifactor. El valor de cadena identifica el tipo de factor adicional que se requiere. En la mayoría de los casos, no sabrá en tiempo de desarrollo si el inquilino del usuario requiere un factor adicional o cuál debe ser la cadena. Por lo tanto, esta opción se usaría en una llamada de "segundo intento" o después de getAccessToken que Microsoft Graph haya enviado un error solicitando el factor adicional y conteniendo la cadena que se debe usar con la authChallenge opción.

authChallenge?: string;

Valor de propiedad

string

forceAddAccount

Advertencia

Esta API ya está en desuso.

Use allowSignInPrompt instead.

Consultas al usuario que agregue su cuenta de Office (o que cambie a ella, si ya está agregada). El valor predeterminado es false.

forceAddAccount?: boolean;

Valor de propiedad

boolean

forceConsent

Advertencia

Esta API ya está en desuso.

Use allowConsentPrompt instead.

Hace que Office muestre la experiencia de consentimiento del complemento. Es útil si los permisos de Azure del complemento han cambiado o si se ha revocado el consentimiento del usuario. El valor predeterminado es false.

forceConsent?: boolean;

Valor de propiedad

boolean

forMSGraphAccess

Hace que Office devuelva un error descriptivo cuando el complemento quiere acceder a Microsoft Graph y el usuario o administrador no ha concedido consentimiento a los ámbitos de Graph. El valor predeterminado es false. Office solo admite el consentimiento para ámbitos de Graph cuando un administrador de inquilinos ha implementado el complemento. Si establece esta opción en true hará que Office informe al complemento de antemano (devolviendo un error descriptivo) si se producirá un error en el acceso a Graph.

forMSGraphAccess?: boolean;

Valor de propiedad

boolean

Comentarios

Nota: si está desarrollando un complemento de Outlook que usa el inicio de sesión único (SSO), marque la forMSGraphAccess opción antes de transferir localmente el complemento para probarlo. De lo contrario, recibirá el error 13012. Para obtener instrucciones adicionales, consulte Detalles sobre SSO con un complemento de Outlook.