Office.AuthOptions interface

  • Ссылка
Пакет:
office

Предоставляет параметры для взаимодействия с пользователем, когда Office получает маркер доступа к надстройке из AAD версии 2.0 с getAccessToken помощью метода .

Свойства

allowConsentPrompt

Позволяет Office получать маркер доступа автоматически или с помощью интерактивного согласия, если оно требуется. Значение по умолчанию — false. Если задано значение false, Office автоматически попытается получить маркер доступа. Если это не удается сделать, Office вернет описательную ошибку. Если задано значение true, Office будет отображать интерактивный пользовательский интерфейс согласия после того, как не удается автоматически получить маркер доступа. Запрос разрешает согласие только для области профиля AAD, но не для областей Microsoft Graph.
allowSignInPrompt

Позволяет Office получать маркер доступа автоматически при условии предоставления согласия или отображать интерактивный пользовательский интерфейс для входа пользователя. Значение по умолчанию — false. Если задано значение false, Office автоматически попытается получить маркер доступа. Если это не удается сделать, Office вернет описательную ошибку. Если задано значение true, office будет отображать интерактивный пользовательский интерфейс входа после того, как не удается автоматически получить маркер доступа.
asyncContext

Определяемый пользователем элемент любого типа, который возвращается без изменений в asyncContext свойстве AsyncResult объекта, передаваемого обратному вызову.
authChallenge

Заставляет Office запрашивать у пользователя дополнительный фактор, если арендатору, на который ориентируется Microsoft Graph, требуется многофакторная проверка подлинности. Строковое значение определяет тип дополнительного фактора, который требуется. В большинстве случаев во время разработки вы не узнаете, требуется ли клиенту пользователя дополнительный фактор или какая строка должна быть. Таким образом, этот параметр будет использоваться в вызове getAccessToken "second try" после того, как Microsoft Graph отправил ошибку с запросом дополнительного коэффициента и содержит строку, которую следует использовать с параметром authChallenge .
forceAddAccount

Предлагает пользователю добавить свою учетную запись Office (или переключиться на нее, если она уже добавлена). Значение по умолчанию — false.

Предупреждение: forceAddAccount не рекомендуется. Вместо этого используйте allowSignInPrompt .
forceConsent

Сообщает Office, что нужно показать интерфейс согласия для надстройки. Это полезно, если разрешения Azure изменились или согласие пользователя было отозвано. Значение по умолчанию — false.

Предупреждение: forceConsent не рекомендуется. Вместо этого используйте allowConsentPrompt .
forMSGraphAccess

Заставляет Office возвращать описательную ошибку, если надстройка хочет получить доступ к Microsoft Graph, а пользователь или администратор не предоставил согласие на области Graph. Значение по умолчанию — false. Office поддерживает согласие только для областей Graph, когда надстройка развернута администратором клиента. Если для этого параметра задано значение , true Office заранее сообщит надстройке (возвращая описательную ошибку), если доступ к Graph завершится ошибкой.

Сведения о свойстве

allowConsentPrompt

Позволяет Office получать маркер доступа автоматически или с помощью интерактивного согласия, если оно требуется. Значение по умолчанию — false. Если задано значение false, Office автоматически попытается получить маркер доступа. Если это не удается сделать, Office вернет описательную ошибку. Если задано значение true, Office будет отображать интерактивный пользовательский интерфейс согласия после того, как не удается автоматически получить маркер доступа. Запрос разрешает согласие только для области профиля AAD, но не для областей Microsoft Graph.

allowConsentPrompt?: boolean;

Значение свойства

boolean

allowSignInPrompt

Позволяет Office получать маркер доступа автоматически при условии предоставления согласия или отображать интерактивный пользовательский интерфейс для входа пользователя. Значение по умолчанию — false. Если задано значение false, Office автоматически попытается получить маркер доступа. Если это не удается сделать, Office вернет описательную ошибку. Если задано значение true, office будет отображать интерактивный пользовательский интерфейс входа после того, как не удается автоматически получить маркер доступа.

allowSignInPrompt?: boolean;

Значение свойства

boolean

asyncContext

Определяемый пользователем элемент любого типа, который возвращается без изменений в asyncContext свойстве AsyncResult объекта, передаваемого обратному вызову.

asyncContext?: any;

Значение свойства

any

authChallenge

Заставляет Office запрашивать у пользователя дополнительный фактор, если арендатору, на который ориентируется Microsoft Graph, требуется многофакторная проверка подлинности. Строковое значение определяет тип дополнительного фактора, который требуется. В большинстве случаев во время разработки вы не узнаете, требуется ли клиенту пользователя дополнительный фактор или какая строка должна быть. Таким образом, этот параметр будет использоваться в вызове getAccessToken "second try" после того, как Microsoft Graph отправил ошибку с запросом дополнительного коэффициента и содержит строку, которую следует использовать с параметром authChallenge .

authChallenge?: string;

Значение свойства

string

forceAddAccount

Предупреждение

Теперь этот API является нерекомендуемым.

Use allowSignInPrompt instead.

Предлагает пользователю добавить свою учетную запись Office (или переключиться на нее, если она уже добавлена). Значение по умолчанию — false.

Предупреждение: forceAddAccount не рекомендуется. Вместо этого используйте allowSignInPrompt .

forceAddAccount?: boolean;

Значение свойства

boolean

forceConsent

Предупреждение

Теперь этот API является нерекомендуемым.

Use allowConsentPrompt instead.

Сообщает Office, что нужно показать интерфейс согласия для надстройки. Это полезно, если разрешения Azure изменились или согласие пользователя было отозвано. Значение по умолчанию — false.

Предупреждение: forceConsent не рекомендуется. Вместо этого используйте allowConsentPrompt .

forceConsent?: boolean;

Значение свойства

boolean

forMSGraphAccess

Заставляет Office возвращать описательную ошибку, если надстройка хочет получить доступ к Microsoft Graph, а пользователь или администратор не предоставил согласие на области Graph. Значение по умолчанию — false. Office поддерживает согласие только для областей Graph, когда надстройка развернута администратором клиента. Если для этого параметра задано значение , true Office заранее сообщит надстройке (возвращая описательную ошибку), если доступ к Graph завершится ошибкой.

forMSGraphAccess?: boolean;

Значение свойства

boolean

Комментарии

Примечание. Если вы разрабатываете надстройку Outlook, которая использует единый вход ( SSO), закомментируйте forMSGraphAccess параметр перед загрузкой неопубликованного надстройки для тестирования. В противном случае появится сообщение об ошибке 13012. Дополнительные рекомендации см. в статье Сведения об едином входе в надстройке Outlook.