Office.AuthOptions interface

Pacote:

office

Fornece opções para a experiência do usuário quando o Office obtém um token de acesso ao suplemento do AAD v. 2.0 com o getAccessToken método.

Propriedades

allowConsentPrompt	Permite que o Office obtenha um token de acesso silenciosamente ou por meio de consentimento interativo, se for necessário. O valor padrão é false. Se definido como false, o Office tentará silenciosamente obter um token de acesso. Se não o fizer, o Office retornará um erro descritivo. Se definido como true, o Office mostrará uma interface do usuário de consentimento interativo depois que ele não conseguir obter silenciosamente um token de acesso. O prompt só permitirá o consentimento para o escopo do perfil do AAD, não para quaisquer escopos do Microsoft Graph.
allowSignInPrompt	Permite que o Office obtenha um token de acesso fornecido silenciosamente, desde que o consentimento esteja presente ou mostre a interface do usuário interativa para entrar no usuário. O valor padrão é false. Se definido como false, o Office tentará silenciosamente obter um token de acesso. Se não o fizer, o Office retornará um erro descritivo. Se definido como true, o Office mostrará uma interface do usuário de entrada interativa depois que ele não conseguir obter silenciosamente um token de acesso.
asyncContext	Um item definido pelo usuário de qualquer tipo retornado, inalterado, na asyncContext propriedade do AsyncResult objeto que é passado para um retorno de chamada.
authChallenge	Faz com que o Office solicite que o usuário forneça o fator adicional quando a locação que está sendo direcionada pelo Microsoft Graph requer autenticação multifator. O valor da cadeia de caracteres identifica o tipo de fator adicional necessário. Na maioria dos casos, você não saberá no momento do desenvolvimento se o locatário do usuário requer um fator adicional ou qual deve ser a cadeia de caracteres. Portanto, essa opção seria usada em uma chamada de "segunda tentativa" após getAccessToken o Microsoft Graph enviar um erro solicitando o fator adicional e contendo a cadeia de caracteres que deve ser usada com a opção authChallenge .
forceAddAccount	Solicita que o usuário adicione sua conta do Office (ou alterne para ela, se ela já for adicionada). O valor padrão é false. Aviso: forceAddAccount foi preterido. Use allowSignInPrompt em vez disso.
forceConsent	Faz com que o Office exiba a experiência de consentimento do suplemento. Será útil se as permissões do Azure do suplemento tiverem sido alteradas ou se o consentimento do usuário tiver sido revogado. O valor padrão é false. Aviso: forceConsent foi preterido. Use allowConsentPrompt em vez disso.
forMSGraphAccess	Faz com que o Office retorne um erro descritivo quando o suplemento deseja acessar o Microsoft Graph e o usuário/administrador não concedeu consentimento aos escopos do Graph. O valor padrão é false. O Office só dá suporte ao consentimento para escopos do Graph quando o suplemento foi implantado por um administrador de locatário. A configuração dessa opção fará com que true o Office informe seu suplemento com antecedência (retornando um erro descritivo) se o acesso ao Graph falhar.

Detalhes da propriedade

allowConsentPrompt

Permite que o Office obtenha um token de acesso silenciosamente ou por meio de consentimento interativo, se for necessário. O valor padrão é false. Se definido como false, o Office tentará silenciosamente obter um token de acesso. Se não o fizer, o Office retornará um erro descritivo. Se definido como true, o Office mostrará uma interface do usuário de consentimento interativo depois que ele não conseguir obter silenciosamente um token de acesso. O prompt só permitirá o consentimento para o escopo do perfil do AAD, não para quaisquer escopos do Microsoft Graph.

allowConsentPrompt?: boolean;

Valor da propriedade

boolean

allowSignInPrompt

Permite que o Office obtenha um token de acesso fornecido silenciosamente, desde que o consentimento esteja presente ou mostre a interface do usuário interativa para entrar no usuário. O valor padrão é false. Se definido como false, o Office tentará silenciosamente obter um token de acesso. Se não o fizer, o Office retornará um erro descritivo. Se definido como true, o Office mostrará uma interface do usuário de entrada interativa depois que ele não conseguir obter silenciosamente um token de acesso.

allowSignInPrompt?: boolean;

Valor da propriedade

boolean

asyncContext

Um item definido pelo usuário de qualquer tipo retornado, inalterado, na asyncContext propriedade do AsyncResult objeto que é passado para um retorno de chamada.

asyncContext?: any;

Valor da propriedade

any

authChallenge

Faz com que o Office solicite que o usuário forneça o fator adicional quando a locação que está sendo direcionada pelo Microsoft Graph requer autenticação multifator. O valor da cadeia de caracteres identifica o tipo de fator adicional necessário. Na maioria dos casos, você não saberá no momento do desenvolvimento se o locatário do usuário requer um fator adicional ou qual deve ser a cadeia de caracteres. Portanto, essa opção seria usada em uma chamada de "segunda tentativa" após getAccessToken o Microsoft Graph enviar um erro solicitando o fator adicional e contendo a cadeia de caracteres que deve ser usada com a opção authChallenge .

authChallenge?: string;

Valor da propriedade

string

forceAddAccount

Aviso

Essa API foi preterida.

Use allowSignInPrompt instead.

Solicita que o usuário adicione sua conta do Office (ou alterne para ela, se ela já for adicionada). O valor padrão é false.

Aviso: forceAddAccount foi preterido. Use allowSignInPrompt em vez disso.

forceAddAccount?: boolean;

Valor da propriedade

boolean

forceConsent

Aviso

Essa API foi preterida.

Use allowConsentPrompt instead.

Faz com que o Office exiba a experiência de consentimento do suplemento. Será útil se as permissões do Azure do suplemento tiverem sido alteradas ou se o consentimento do usuário tiver sido revogado. O valor padrão é false.

Aviso: forceConsent foi preterido. Use allowConsentPrompt em vez disso.

forceConsent?: boolean;

Valor da propriedade

boolean

forMSGraphAccess

Faz com que o Office retorne um erro descritivo quando o suplemento deseja acessar o Microsoft Graph e o usuário/administrador não concedeu consentimento aos escopos do Graph. O valor padrão é false. O Office só dá suporte ao consentimento para escopos do Graph quando o suplemento foi implantado por um administrador de locatário. A configuração dessa opção fará com que true o Office informe seu suplemento com antecedência (retornando um erro descritivo) se o acesso ao Graph falhar.

forMSGraphAccess?: boolean;

Valor da propriedade

boolean

Comentários

Observação: se você estiver desenvolvendo um suplemento do Outlook que usa o SSO (logon único), comente a opção forMSGraphAccess antes de carregar o suplemento para teste. Caso contrário, você receberá o erro 13012. Para obter diretrizes adicionais, consulte Detalhes sobre o SSO com um suplemento do Outlook.