AadTokenProvider class
このクラスを使用すると、開発者は Azure AD から OAuth2 トークンを取得できます。
OAuth2 トークンは、SharePoint ページから PowerBI、Sway、Exchange、Yammer などの他のサービスに対してユーザーを認証するために使用されます。
注釈
このクラスは、 @sealedとしてマークされます。 サブクラスでは拡張しないでください。
このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、AadTokenProvider クラスを展開するサブクラスを作成したりすることはできません。
メソッド
| get |
現在ログインしているユーザーがそのリソースにアクセスできる場合は、リソースの AAD OAuth2 トークンをフェッチします。 OAuth2 トークンは、メソッド自体によって既にキャッシュされているため、呼び出し元によってキャッシュされるべきではありません。 |
| get |
イベント
| on |
ページ全体のリダイレクトが発生する前に、開発者に通知します。 |
| popup |
ロジック フローがユーザー操作のためにポップアップ フローを要求するかどうかを開発者に通知します。 |
| token |
トークン取得にユーザー アクションが必要な場合に開発者に通知します。 |
メソッドの詳細
getToken(resourceEndpoint, options)
現在ログインしているユーザーがそのリソースにアクセスできる場合は、リソースの AAD OAuth2 トークンをフェッチします。
OAuth2 トークンは、メソッド自体によって既にキャッシュされているため、呼び出し元によってキャッシュされるべきではありません。
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<BeforeRedirectEventArgs>;イベントの種類
popupEvent
ロジック フローがユーザー操作のためにポップアップ フローを要求するかどうかを開発者に通知します。
readonly popupEvent: SPEvent<PopupEventArgs>;イベントの種類
tokenAcquisitionEvent
トークン取得にユーザー アクションが必要な場合に開発者に通知します。
get tokenAcquisitionEvent(): SPEvent<TokenAcquisitionEventArgs>;