IAadTokenProvider interface
此类允许开发人员从 Azure AD 获取 OAuth2 令牌。
OAuth2 令牌用于从 SharePoint 页面向其他服务(如 PowerBI、Sway、Exchange、Yammer 等)对用户进行身份验证。
注解
AadTokenProvider 正在替换 /_api。SP。使用 ADAL.js 进行身份验证的 OAuth.Token/获取终结点。 在不久的将来,当 Azure AD v2.0 可以支持与原始版本相同的方案时,我们将切换到 MSAL。
方法
get |
如果当前登录的用户有权访问该资源,则提取资源的 AAD OAuth2 令牌。 OAuth2 令牌不应由调用方缓存,因为它已由 方法本身缓存。 resourceEndpoint 的示例为 https://sdfpilot.outlook.com |
get |
事件
on |
在发生整页重定向之前通知开发人员。 |
popup |
在发生整页重定向之前通知开发人员。 |
token |
当 Token Acquistion 需要用户操作时通知开发人员。 |
方法详细信息
getToken(resourceEndpoint, options)
如果当前登录的用户有权访问该资源,则提取资源的 AAD OAuth2 令牌。
OAuth2 令牌不应由调用方缓存,因为它已由 方法本身缓存。
resourceEndpoint 的示例为 https://sdfpilot.outlook.com
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<IBeforeRedirectEventArgs>;
事件类型
popupEvent
tokenAcquisitionEvent
当 Token Acquistion 需要用户操作时通知开发人员。
readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;