IAadTokenProvider interface
このクラスを使用すると、開発者は Azure AD から OAuth2 トークンを取得できます。
OAuth2 トークンは、SharePoint ページから PowerBI、Sway、Exchange、Yammer などの他のサービスに対してユーザーを認証するために使用されます。
注釈
AadTokenProvider は /_apiを置き換えます。SP。OAuth.Token/Acquire endpoint for authentication with ADAL.js。 近い将来、Azure AD v2.0 が元のバージョンと同じシナリオをサポートできる場合は、MSAL に切り替えます。
メソッド
get |
現在ログインしているユーザーがそのリソースにアクセスできる場合は、リソースの AAD OAuth2 トークンをフェッチします。 OAuth2 トークンは、メソッド自体によって既にキャッシュされているため、呼び出し元によってキャッシュされるべきではありません (SHOULD)。 resourceEndpoint の例を次に示します。 https://sdfpilot.outlook.com |
get |
イベント
on |
ページ全体のリダイレクトが発生する前に、開発者に通知します。 |
popup |
ページ全体のリダイレクトが発生する前に、開発者に通知します。 |
token |
Token Acquistion にユーザー アクションが必要な場合に開発者に通知します。 |
メソッドの詳細
getToken(resourceEndpoint, options)
現在ログインしているユーザーがそのリソースにアクセスできる場合は、リソースの AAD OAuth2 トークンをフェッチします。
OAuth2 トークンは、メソッド自体によって既にキャッシュされているため、呼び出し元によってキャッシュされるべきではありません (SHOULD)。
resourceEndpoint の例を次に示します。 https://sdfpilot.outlook.com
getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;
パラメーター
- resourceEndpoint
-
string
トークンを取得するリソース
- options
- IGetTokenOptions
戻り値
Promise<string>
トークンで完全にファイルされるか、エラー メッセージで拒否される promise
getToken(resourceEndpoint, useCachedToken)
getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;
パラメーター
- resourceEndpoint
-
string
- useCachedToken
-
boolean
戻り値
Promise<string>
イベントの詳細
onBeforeRedirectEvent
ページ全体のリダイレクトが発生する前に、開発者に通知します。
readonly onBeforeRedirectEvent: SPEvent<IBeforeRedirectEventArgs>;
イベントの種類
popupEvent
ページ全体のリダイレクトが発生する前に、開発者に通知します。
readonly popupEvent: SPEvent<IPopupEventArgs>;
イベントの種類
tokenAcquisitionEvent
Token Acquistion にユーザー アクションが必要な場合に開発者に通知します。
readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;