ClientApplicationBase.AcquireTokenSilent メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| AcquireTokenSilent(IEnumerable<String>, IAccount) |
[V3 API]ユーザー トークン キャッシュから |
| AcquireTokenSilent(IEnumerable<String>, String) |
[V3 API]Usernameが特定の |
AcquireTokenSilent(IEnumerable<String>, IAccount)
[V3 API]ユーザー トークン キャッシュから account のアクセス トークンの取得を試みます。
詳細については、 https://aka.ms/msal-net-acquiretokensilent を参照してください
public Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent(System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.IAccount account);abstract member AcquireTokenSilent : seq<string> * Microsoft.Identity.Client.IAccount -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder
override this.AcquireTokenSilent : seq<string> * Microsoft.Identity.Client.IAccount -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilderPublic Function AcquireTokenSilent (scopes As IEnumerable(Of String), account As IAccount) As AcquireTokenSilentParameterBuilderパラメーター
- scopes
- IEnumerable<String>
保護された API へのアクセスを要求されたスコープ
- account
- IAccount
トークンが要求されるアカウント。
返品
省略可能なパラメーターを追加して、トークン要求をビルドするために使用されるAcquireTokenSilentParameterBuilder
実装
例外
は、アプリケーションのエンド ユーザーとの対話が必要な場合 (たとえば、キャッシュに更新トークンがなかった場合、ユーザーが同意する必要がある場合、または再サインインする必要がある場合 (パスワードの有効期限が切れている場合など)、またはユーザーが 2 要素認証を実行する必要がある場合にスローされます。
注釈
アクセス トークンには、 少なくとも すべての要求されたスコープが含まれている場合、一致と見なされます。 つまり、要求されたスコープよりも多くのスコープを持つアクセス トークンが返される可能性があります。 アクセス トークンの有効期限が切れているか、有効期限が近づいている場合 (5 分以内) は、キャッシュされた更新トークン (使用可能な場合) を使用して、サイレント ネットワーク呼び出しを行って新しいアクセス トークンを取得します。
追加のパラメーターを設定するには、ビルダーを次のように連結します。 WithTenantId(String) は、アプリケーション構築 WithForceRefresh(Boolean) で設定された機関とは異なる機関のトークンを要求し、ユーザー トークン キャッシュをバイパスしてトークンを強制的に更新し、追加のクエリ パラメーターを指定する Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String}) を指定します。
適用対象
AcquireTokenSilent(IEnumerable<String>, String)
[V3 API]Usernameが特定のloginHintと一致するIAccountのアクセス トークンをユーザー トークン キャッシュから取得しようとします。
詳細については、 https://aka.ms/msal-net-acquiretokensilent を参照してください
public Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent(System.Collections.Generic.IEnumerable<string> scopes, string loginHint);abstract member AcquireTokenSilent : seq<string> * string -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder
override this.AcquireTokenSilent : seq<string> * string -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilderPublic Function AcquireTokenSilent (scopes As IEnumerable(Of String), loginHint As String) As AcquireTokenSilentParameterBuilderパラメーター
- scopes
- IEnumerable<String>
保護された API へのアクセスを要求されたスコープ
- loginHint
- String
通常、UPN 形式のユーザー名 (例: johnd@contoso.com
返品
省略可能なパラメーターを追加して、トークン要求をビルドするために使用されるAcquireTokenSilentParameterBuilder
実装
例外
は、アプリケーションのエンド ユーザーとの対話が必要な場合 (たとえば、キャッシュに更新トークンがなかった場合、ユーザーが同意する必要がある場合、または再サインインする必要がある場合 (パスワードの有効期限が切れている場合など)、またはユーザーが 2 要素認証を実行する必要がある場合にスローされます。
注釈
複数の IAccount が loginHintと一致する場合、または一致するものがない場合は、例外がスローされます。
アクセス トークンには、 少なくとも すべての要求されたスコープが含まれている場合、一致と見なされます。 つまり、要求されたスコープよりも多くのスコープを持つアクセス トークンが返される可能性があります。 アクセス トークンの有効期限が切れているか、有効期限が近づいている場合 (5 分以内) は、キャッシュされた更新トークン (使用可能な場合) を使用して、サイレント ネットワーク呼び出しを行って新しいアクセス トークンを取得します。
追加のパラメーターを設定するには、ビルダーを次のように連結します。 WithTenantId(String) は、アプリケーション構築 WithForceRefresh(Boolean) で設定された機関とは異なる機関のトークンを要求し、ユーザー トークン キャッシュをバイパスしてトークンを強制的に更新し、追加のクエリ パラメーターを指定する Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String}) を指定します。