ClientApplication class
すべての ClientApplication の基本抽象クラス - パブリックと社外秘
メソッド
| acquire |
OAuth2.0 承認コード フローの最初の手順から受信した承認コードを交換してトークンを取得します。
|
| acquire |
新しいトークン セットに対して提供された更新トークンを交換してトークンを取得します。 この API は、ADAL から MSAL に移行するシナリオでのみ提供されます。 それ以外の場合は、サイレント シナリオに |
| acquire |
クライアント アプリケーションのユーザー名とパスワードを資格情報と交換して、パスワード付与を使用してトークンを取得します 最新の OAuth 2.0 セキュリティのベスト カレント プラクティスでは、パスワードの付与が完全に禁止されています。 この推奨事項の詳細については、https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoftのドキュメントと推奨事項を次に示します。https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| acquire |
ユーザーがトークンが要求されるアカウントを指定すると、トークンをサイレントで取得します。 この API は、ユーザーがアカウント オブジェクトを提供することを想定し、キャッシュを調んでトークンが存在する場合は取得します。
また、access_tokenとid_tokenのキャッシュをバイパスするためにユーザーが送信できる省略可能な "forceRefresh" ブール値もあります。
refresh_tokenの有効期限が切れているか見つからない場合は、エラーがスローされ、ユーザーが対話型トークン取得 API (例: |
| clear |
キャッシュをクリアする |
| get |
承認要求の URL を作成し、ユーザーが資格情報を入力し、アプリケーションに同意できるようにする。 URL は、アプリケーション オブジェクトで構成された機関の /authorize エンドポイントを対象とします。 ユーザーが資格情報と同意を入力すると、機関は要求で送信されたリダイレクト URI に応答を送信し、承認コードを含める必要があります。このコードを使用して、 |
| get |
ロガー インスタンスを返します。 |
| get |
アプリケーションのトークン キャッシュを取得します。 |
| set |
構成で設定された既定のロガーを新しい Logger に新しい構成に置き換えます |
メソッドの詳細
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
OAuth2.0 承認コード フローの最初の手順から受信した承認コードを交換してトークンを取得します。
getAuthCodeUrl(AuthorizationCodeUrlRequest) を使用して、OAuth2.0 承認コード フローの最初の手順の URL を作成できます。 AuthorizationCodeUrlRequest と AuthorizationCodeRequest の redirectUri とスコープの値が同じであることを確認します。
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
パラメーター
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
返品
Promise<AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
新しいトークン セットに対して提供された更新トークンを交換してトークンを取得します。
この API は、ADAL から MSAL に移行するシナリオでのみ提供されます。 それ以外の場合は、サイレント シナリオに acquireTokenSilent() を使用することをお勧めします。
acquireTokenSilent()を使用すると、MSAL はトークンのキャッシュと更新を自動的に処理します。
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
パラメーター
- request
- RefreshTokenRequest
返品
Promise<null | AuthenticationResult>
acquireTokenByUsernamePassword(UsernamePasswordRequest)
警告
この API は非推奨になりました。
- Use a more secure flow instead
クライアント アプリケーションのユーザー名とパスワードを資格情報と交換して、パスワード付与を使用してトークンを取得します
最新の OAuth 2.0 セキュリティのベスト カレント プラクティスでは、パスワードの付与が完全に禁止されています。 この推奨事項の詳細については、https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoftのドキュメントと推奨事項を次に示します。https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
パラメーター
- request
- UsernamePasswordRequest
UsenamePasswordRequest
返品
Promise<null | AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
ユーザーがトークンが要求されるアカウントを指定すると、トークンをサイレントで取得します。
この API は、ユーザーがアカウント オブジェクトを提供することを想定し、キャッシュを調んでトークンが存在する場合は取得します。
また、access_tokenとid_tokenのキャッシュをバイパスするためにユーザーが送信できる省略可能な "forceRefresh" ブール値もあります。
refresh_tokenの有効期限が切れているか見つからない場合は、エラーがスローされ、ユーザーが対話型トークン取得 API (例: acquireTokenByCode()) を呼び出すガイダンスが表示されます。
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
パラメーター
- request
- SilentFlowRequest
返品
Promise<AuthenticationResult>
clearCache()
キャッシュをクリアする
function clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
承認要求の URL を作成し、ユーザーが資格情報を入力し、アプリケーションに同意できるようにする。 URL は、アプリケーション オブジェクトで構成された機関の /authorize エンドポイントを対象とします。
ユーザーが資格情報と同意を入力すると、機関は要求で送信されたリダイレクト URI に応答を送信し、承認コードを含める必要があります。このコードを使用して、 acquireTokenByCode(AuthorizationCodeRequest)経由でトークンを取得できます。
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
パラメーター
- request
- AuthorizationUrlRequest
返品
Promise<string>
getLogger()
getTokenCache()
setLogger(Logger)
構成で設定された既定のロガーを新しい Logger に新しい構成に置き換えます
function setLogger(logger: Logger)
パラメーター
- logger
- Logger
Logger インスタンス