AadTokenProvider class

Пакет:

@microsoft/sp-http-base

Этот класс позволяет разработчику получать маркеры OAuth2 из Azure AD.

Маркеры OAuth2 используются для проверки подлинности пользователя со страницы SharePoint в других службах, таких как PowerBI, Sway, Exchange, Yammer и т. д.

Комментарии

Этот класс помечается как @sealed. Подклассы не должны расширять его.

Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс AadTokenProvider.

Методы

getToken(resourceEndpoint, options)	Извлекает маркер AAD OAuth2 для ресурса, если пользователь, вошедший в систему, имеет доступ к данному ресурсу. Маркер OAuth2 не должен кэшироваться вызывающим объектом, так как он уже кэшируется самим методом .
getToken(resourceEndpoint, useCachedToken)

События

onBeforeRedirectEvent	Уведомляет разработчика перед началом полного перенаправления страницы.
popupEvent	Уведомляет разработчика, если поток логики хочет запросить поток всплывающего окна для взаимодействия с пользователем.
tokenAcquisitionEvent	Уведомляет разработчика о том, что для получения маркера требуется действие пользователя.

Сведения о методе

getToken(resourceEndpoint, options)

Извлекает маркер AAD OAuth2 для ресурса, если пользователь, вошедший в систему, имеет доступ к данному ресурсу.

Маркер OAuth2 не должен кэшироваться вызывающим объектом, так как он уже кэшируется самим методом .

getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;

Параметры

resourceEndpoint

string

ресурс, для которого должен быть получен маркер;

options

IGetTokenOptions

Возвращаемое значение

Promise<string>

Обещание, которое будет выполнено с помощью маркера или отклонено с сообщением об ошибке

getToken(resourceEndpoint, useCachedToken)

getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;

Параметры

resourceEndpoint

string

useCachedToken

boolean

Возвращаемое значение

Promise<string>

Сведения о событии

onBeforeRedirectEvent

Уведомляет разработчика перед началом полного перенаправления страницы.

readonly onBeforeRedirectEvent: SPEvent<BeforeRedirectEventArgs>;

Тип события

SPEvent<BeforeRedirectEventArgs>

popupEvent

Уведомляет разработчика, если поток логики хочет запросить поток всплывающего окна для взаимодействия с пользователем.

readonly popupEvent: SPEvent<PopupEventArgs>;

Тип события

SPEvent<PopupEventArgs>

tokenAcquisitionEvent

Уведомляет разработчика о том, что для получения маркера требуется действие пользователя.

get tokenAcquisitionEvent(): SPEvent<TokenAcquisitionEventArgs>;

Тип события

SPEvent<TokenAcquisitionEventArgs>