OfficeRuntime.AuthOptions interface

Pacote:
office-runtime

Aviso

Essa API foi preterida.

Use the Office.AuthOptions interface instead.

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

Comentários

Os métodos nesta interface são equivalentes aos da Office.AuthOptions interface. Se novos tipos de autenticação forem adicionados no futuro, eles serão adicionados apenas à Office.AuthOptions interface. Para simplificar, os exemplos de código em toda a documentação usam Office.AuthOptions.

Usada por

Exemplos

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

Propriedades

allowConsentPrompt

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

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

Um item definido pelo usuário de qualquer tipo que é 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 authChallenge opção.
forceAddAccount

Prompts para o usuário adicionar sua conta do Office (ou mudar para ela, se ela já estiver adicionada). O valor padrão é 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 padrão é false.
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ários. Definir essa opção como true fará com que 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 necessário. O valor padrão é false. Se definido como false, o Office tentará silenciosamente obter um token de acesso. Se não fizer isso, o Office retornará um erro descritivo. Se definido como true, o Office mostrará uma interface do usuário de consentimento interativa depois que ele não conseguir obter silenciosamente um token de acesso. O prompt só permitirá consentimento para o escopo de perfil do AAD, não para qualquer escopo do Microsoft Graph.

allowConsentPrompt?: boolean;

Valor da propriedade

boolean

allowSignInPrompt

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

allowSignInPrompt?: boolean;

Valor da propriedade

boolean

asyncContext

Um item definido pelo usuário de qualquer tipo que é 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 authChallenge opção.

authChallenge?: string;

Valor da propriedade

string

forceAddAccount

Aviso

Essa API foi preterida.

Use allowSignInPrompt instead.

Prompts para o usuário adicionar sua conta do Office (ou mudar para ela, se ela já estiver adicionada). O valor padrão é 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 padrão é false.

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ários. Definir essa opção como true fará com que 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 SSO (logon único), comente a forMSGraphAccess opção antes de fazer o sideload do suplemento para teste. Caso contrário, você receberá o erro 13012. Para obter orientações adicionais, confira Detalhes sobre SSO com um suplemento do Outlook.