Office.AuthOptions interface

Pacote:

office

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

Propriedades

allowConsentPrompt	Permite que o Office obtenha um token de acesso silenciosamente ou através do consentimento interativo, se for necessário. O valor predefinido é false. Se estiver definido como false, o Office tentará obter automaticamente um token de acesso. Se não o fizer, o Office devolverá um erro descritivo. Se estiver definido como true, o Office mostrará uma IU de consentimento interativo depois de não conseguir obter automaticamente um token de acesso. O pedido só permitirá o consentimento para o âmbito do perfil do AAD e não para quaisquer âmbitos do Microsoft Graph.
allowSignInPrompt	Permite que o Office obtenha um token de acesso de forma silenciosa, desde que o consentimento esteja presente ou mostre uma IU interativa para iniciar sessão no utilizador. O valor predefinido é false. Se estiver definido como false, o Office tentará obter automaticamente um token de acesso. Se não o fizer, o Office devolverá um erro descritivo. Se estiver definido como true, o Office mostrará uma IU de início de sessão interativa depois de não conseguir obter automaticamente um token de acesso.
asyncContext	Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na asyncContext propriedade do AsyncResult objeto que é transmitido a uma chamada de retorno.
authChallenge	Faz com que o Office peça ao utilizador para fornecer o fator adicional quando o inquilino que está a ser visado pelo Microsoft Graph requer autenticação multifator. O valor da cadeia identifica o tipo de fator adicional que é necessário. Na maioria dos casos, não saberá no momento do desenvolvimento se o inquilino do utilizador necessita de um fator adicional ou qual deve ser a cadeia. Portanto, esta opção seria utilizada numa chamada de "segunda tentativa" de depois de getAccessToken o Microsoft Graph ter enviado um erro a pedir o fator adicional e a conter a cadeia que deve ser utilizada com a opção authChallenge .
forceAddAccount	Solicitações o utilizador para adicionar a respetiva conta do Office (ou para mudar para a mesma, se já estiver adicionada). O valor predefinido é false.
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 predefinido é false.
forMSGraphAccess	Faz com que o Office devolva um erro descritivo quando o suplemento quer aceder ao Microsoft Graph e o utilizador/administrador não concedeu consentimento aos âmbitos do Graph. O valor predefinido é false. O Office só suporta o consentimento para os âmbitos do Graph quando o suplemento tiver sido implementado por um administrador de inquilinos. Definir esta opção como true fará com que o Office informe previamente o seu suplemento (devolvendo um erro descritivo) se o acesso ao Graph falhar.

Detalhes da propriedade

allowConsentPrompt

Permite que o Office obtenha um token de acesso silenciosamente ou através do consentimento interativo, se for necessário. O valor predefinido é false. Se estiver definido como false, o Office tentará obter automaticamente um token de acesso. Se não o fizer, o Office devolverá um erro descritivo. Se estiver definido como true, o Office mostrará uma IU de consentimento interativo depois de não conseguir obter automaticamente um token de acesso. O pedido só permitirá o consentimento para o âmbito do perfil do AAD e não para quaisquer âmbitos do Microsoft Graph.

allowConsentPrompt?: boolean;

Valor da propriedade

boolean

allowSignInPrompt

Permite que o Office obtenha um token de acesso de forma silenciosa, desde que o consentimento esteja presente ou mostre uma IU interativa para iniciar sessão no utilizador. O valor predefinido é false. Se estiver definido como false, o Office tentará obter automaticamente um token de acesso. Se não o fizer, o Office devolverá um erro descritivo. Se estiver definido como true, o Office mostrará uma IU de início de sessão interativa depois de não conseguir obter automaticamente um token de acesso.

allowSignInPrompt?: boolean;

Valor da propriedade

boolean

asyncContext

Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na asyncContext propriedade do AsyncResult objeto que é transmitido a uma chamada de retorno.

asyncContext?: any;

Valor da propriedade

any

authChallenge

Faz com que o Office peça ao utilizador para fornecer o fator adicional quando o inquilino que está a ser visado pelo Microsoft Graph requer autenticação multifator. O valor da cadeia identifica o tipo de fator adicional que é necessário. Na maioria dos casos, não saberá no momento do desenvolvimento se o inquilino do utilizador necessita de um fator adicional ou qual deve ser a cadeia. Portanto, esta opção seria utilizada numa chamada de "segunda tentativa" de depois de getAccessToken o Microsoft Graph ter enviado um erro a pedir o fator adicional e a conter a cadeia que deve ser utilizada com a opção authChallenge .

authChallenge?: string;

Valor da propriedade

string

forceAddAccount

Aviso

Essa API foi preterida.

Use allowSignInPrompt instead.

Solicitações o utilizador para adicionar a respetiva conta do Office (ou para mudar para a mesma, se já estiver adicionada). O valor predefinido é false.

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 predefinido é false.

forceConsent?: boolean;

Valor da propriedade

boolean

forMSGraphAccess

Faz com que o Office devolva um erro descritivo quando o suplemento quer aceder ao Microsoft Graph e o utilizador/administrador não concedeu consentimento aos âmbitos do Graph. O valor predefinido é false. O Office só suporta o consentimento para os âmbitos do Graph quando o suplemento tiver sido implementado por um administrador de inquilinos. Definir esta opção como true fará com que o Office informe previamente o seu suplemento (devolvendo um erro descritivo) se o acesso ao Graph falhar.

forMSGraphAccess?: boolean;

Valor da propriedade

boolean

Comentários

Nota: se estiver a desenvolver um suplemento do Outlook que utiliza o início de sessão único (SSO), comente a opção forMSGraphAccess antes de colocar o suplemento em sideload para teste. Caso contrário, receberá o erro 13012. Para obter orientações adicionais, veja Detalhes sobre o SSO com um suplemento do Outlook.