IPublicClientApplication interface
パブリック API シグネチャを定義する PublicClientApplication クラスのインターフェイス
メソッド
| acquire |
OAuth 2.0 承認コード フローの最初の手順から受信した承認コードを交換してトークンを取得します。 |
| acquire |
OAuth2.0 デバイス コード フローを使用して機関からトークンを取得します |
| acquire |
新しい一連のトークンに対して提供された更新トークンを交換してトークンを取得します。 |
| acquire |
クライアント アプリケーションのユーザー名とパスワードを資格情報と交換して、パスワード付与を使用してトークンを取得します |
| acquire |
対話形式でトークンを取得します。 |
| acquire |
トークンが要求されるアカウントをユーザーが指定すると、トークンをサイレント モードで取得します。 |
| clear |
キャッシュをクリアする |
| get |
キャッシュされたすべてのアカウントを取得します。 |
| get |
承認要求の URL を作成します |
| get |
ロガー インスタンスを返します。 |
| get |
アプリケーションのトークン キャッシュを取得します |
| set |
構成で設定された既定のロガーを新しい Logger に新しい構成に置き換えます |
| sign |
指定されたアカウントに関連付けられているキャッシュアーティファクトを削除します |
メソッドの詳細
acquireTokenByCode(AuthorizationCodeRequest)
OAuth 2.0 承認コード フローの最初の手順から受信した承認コードを交換してトークンを取得します。
function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>
パラメーター
- request
- AuthorizationCodeRequest
返品
Promise<AuthenticationResult>
acquireTokenByDeviceCode(DeviceCodeRequest)
OAuth2.0 デバイス コード フローを使用して機関からトークンを取得します
function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>
パラメーター
- request
- DeviceCodeRequest
返品
Promise<null | AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
新しい一連のトークンに対して提供された更新トークンを交換してトークンを取得します。
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
パラメーター
- request
- RefreshTokenRequest
返品
Promise<null | AuthenticationResult>
acquireTokenByUsernamePassword(UsernamePasswordRequest)
警告
この API は非推奨になりました。
- Use a more secure flow instead
クライアント アプリケーションのユーザー名とパスワードを資格情報と交換して、パスワード付与を使用してトークンを取得します
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
パラメーター
- request
- UsernamePasswordRequest
返品
Promise<null | AuthenticationResult>
acquireTokenInteractive(InteractiveRequest)
対話形式でトークンを取得します。
function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>
パラメーター
- request
- InteractiveRequest
返品
Promise<AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
トークンが要求されるアカウントをユーザーが指定すると、トークンをサイレント モードで取得します。
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
パラメーター
- request
- SilentFlowRequest
返品
Promise<AuthenticationResult>
clearCache()
キャッシュをクリアする
function clearCache()
getAllAccounts()
キャッシュされたすべてのアカウントを取得します。
function getAllAccounts(): Promise<AccountInfo[]>
返品
Promise<AccountInfo[]>
getAuthCodeUrl(AuthorizationUrlRequest)
承認要求の URL を作成します
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
パラメーター
- request
- AuthorizationUrlRequest
返品
Promise<string>
getLogger()
getTokenCache()
setLogger(Logger)
signOut(SignOutRequest)
指定されたアカウントに関連付けられているキャッシュアーティファクトを削除します
function signOut(request: SignOutRequest): Promise<void>
パラメーター
- request
- SignOutRequest
返品
Promise<void>