Microsoft Entra ID Windows Account Manager (WAM) API リファレンス

  • [アーティクル]

Microsoft Entra ID Windows Account Manager (WAM) の一連の API を使うと、開発者は Windows アプリケーションを統合できます。 以下のパラメーターを Windows プラットフォーム上の MSAL で使うと、Microsoft Entra ID または Microsoft アカウント (MSA) を使ってユーザーがサインインできるようにするアプリケーションの開発が容易になります。

Microsoft Entra ID WAM API リファレンス

パラメーター 値 メモ
authority organizations または特定のトークン発行者 URL。
たとえば、https://login.partner.microsoftonline.cn はこのクラウド環境のトークン発行者 URL です。		 authority パラメーターでは、API 用の ID プロバイダーとクラウド環境を指定します。
resource 開発者がトークンを取得する URL (https://www.sharepoint.com など) resource パラメーターでは、取得する認証トークンのターゲット URL を指定します。
redirect_uri アプリが正し認可されて認可コードまたはアクセス トークンが付与された後、承認サーバーによってユーザーを送られる場所。 注: このパラメーターは、ユニバーサル Windows プラットフォーム (UWP) アプリケーションではサポートされていません。 呼び出し元には、中程度の整合性レベルのアクセス許可が必要です。 「リダイレクト URI (応答 URL) に関する制約と制限」をご覧ください
correlationId データ ソース間で要求を結合するために使用できる、要求ごとに生成される一意の GUID 注: correlationId は従来のパラメーターです。 WAM API 自体のプロパティに置き換えられました。 Windows UWP アプリケーションの WebTokenRequest.CorrelationId Property (Windows.Security.Authentication.Web.Core) に関する記事をご覧ください
validateAuthority ブール値 (TRUE または FALSE)。 Microsoft Entra ID プラグインは、既定で機関の検証を実行します。 アプリケーションでこの検証を無効にする必要がある場合は、validateAuthority に対して値 FALSE を送信する必要があります。 これは、オンプレミスのシナリオで役に立ちます。 「MsalAuthenticationOptions.ValidateAuthority プロパティ」をご覧ください
certificateUsage vpn このパラメーターは、証明書トークンの種類を要求するために使われます。 使用できる値は vpn のみです。 現時点では、これは VPN のシナリオにのみ適用されます。
certificateUIName VPN 証明書の証明書選択 UI に表示される任意の文字列。 certificateUIName パラメーターでは、VPN 証明書を選ぶときに証明書選択ユーザー インターフェイスに表示される文字列を指定します。
certificateUIDescription VPN 証明書の証明書選択 UI に表示される任意の文字列。 certificateUIDescription パラメーターでは、VPN 証明書を選ぶときに説明として証明書選択ユーザー インターフェイスに表示される文字列を指定します。
UserPictureEnabled True または False のいずれかです。 アプリケーションがトークン応答の一部としてユーザーの画像を受け取ることを望むかどうかを示します。
Username ユーザー名 Microsoft Entra ID のユーザー名を表します
Password Password Microsoft Entra ID ユーザーのパスワードを表します
SamlAssertion SAML トークン サード パーティの IDP から Microsoft Entra ID に認証成果物として送信される SAML トークン
SamlAssertionType "urn:ietf:params:oauth:grant-type:saml1_1-bearer" または "urn:ietf:params:oauth:grant-type:saml2-bearer" のいずれか 認証に使われる SAML トークンの種類を指定します。
LoginHint ユーザー名のヒント (UPN) サインイン プロセスの間のユーザー名のヒントを提供します。
msafed 0 または 1 のいずれかです。 Microsoft アカウントを持つユーザーが Entra テナント内でフェデレーション ID としてサインインできるようにするかどうかを決定します。 値 1 はフェデレーションが有効にし、0 は無効にします。
discover Home discover パラメーターは、デバイスが参加しているクラウドではなく、ユーザーのホーム クラウドのコンテキストで、トークン要求が実行されることを示します。
domain_hint 関連するドメイン。 たとえば、contoso.com のように指定します。 Microsoft Entra ID は、ヒントを使ってディレクトリ内のドメインを検索します
注: ドメインとフォールバック ドメインの両方が ADAL によってパラメーターとして渡された場合は、ドメインのヒントが優先されます
fallback_domain ドメイン (contoso.com など) fallback_domain パラメーターは、Microsoft Entra ID がディレクトリ内のドメインの検索に使うヒントです。 これは主に、ユーザーの UPN の一部であるルーティング不可能なユーザー ドメインに使われます。
client_TokenType DeviceAuth client_TokenType パラメーターは、デバイス専用トークンの要求にのみ使われます。 呼び出し元には、中程度の整合性レベルのアクセス許可が必要です。
IsFeatureSupported CrossCloudB2B,
redirect_uri,
TokenBinding		 機能が現在のフローでサポートされているかどうかを調べるために使われます。
prompt no_select または select_account のいずれか prompt パラメーターは、プロンプト ウィンドウの動作を制御します。 no_select は、プロンプト動作の制御がプロンプト ウィンドウに追加されないことを意味します。 select_account は、アカウント ピッカーを表示します。 このパラメーターは、アカウント選択動作を制御するためにログイン サービスに渡されます。
minimum_token_lifetime ミリ秒単位の時間。 これは、新しいトークンの要求と、キャッシュ トークンの破棄が必要になるまでの時間です
telemetry MATS 要求に関するテレメトリを返します
enclave sw はソフトウェア キーを示します。
hw はハードウェア キーを示します。
kg はキーガード キーを示します。
enclave パラメーターでは、使用するキーの種類を指定します。
token_type pop は所有証明トークンを示します
shr は署名済み HTTP 要求トークンを示します		 token_type パラメーターでは、使用するトークンの種類を指定します。
req_cnf token_type が pop のときは、req_cnf パラメーターが使われます。 このフィールドには、所有証明のためにクライアントがアクセス トークンにバインドするキーに関する情報が含まれます。
refresh_binding refresh_binding パラメーターは、今後リリースされる予定のトークン バインド機能の一部です。

関連項目