Microsoft アカウント (MSA) サーバー側 API リファレンス

  • [アーティクル]

Microsoft アカウント (MSA) は、ユーザーが単一の資格情報セットを使用して Web サイト、アプリケーション、サービスにログインできるようにするシングル サインオン Web サービスです。 Microsoft アカウント (MSA) サーバー側 API には、認証プロセスをカスタマイズして、ユーザー エクスペリエンスを強化するために使用できるさまざまなパラメータが用意されています。

これらのパラメータは、Windows プラットフォーム上の MSAL で使用できるため、Microsoft アカウントを介してサインインするユーザーとシームレスに統合する Windows アプリケーションの開発が容易になります。

MSA サーバー側 API

これらは、login.microsoftonline.com?parametername=value という形式で、URL パラメータとして login.microsoftonline.com または login.live.com に渡されます。

パラメーター 値 メモ
ImplicitAssociate 0/1 1 に設定すると、ユーザーがサインインに使用する Microsoft アカウント (MSA) は、ユーザーの確認を必要とせずに、Windows 上のアプリケーションに自動的にリンクされます。
注: これにより、ユーザーのシングル サインオン (SSO) は有効になりません。
LoginHint username 既に指定されている (たとえば、更新トークンを使用して) 場合を除き、サインイン時にユーザー名を事前入力します。 ユーザーは、必要に応じて、この事前入力されたユーザー名を変更できます。
cobrandid コブランディング GUID このパラメータは、サインイン ユーザー エクスペリエンスにコブランディングを適用します。 コブランディングを使用すると、アプリのロゴ、背景画像、サブタイトル テキスト、説明テキスト、ボタンの色などの要素をカスタマイズできます。 アプリケーションを Microsoft アカウントのサインインと統合しており、サインイン スクリーンをカスタマイズする場合は、Microsoft サポートにお問い合わせください。
client_flight String client_flight は、サインイン プロセスの完了時にアプリケーションに返されるパススルー パラメータです。 このパラメータの値はテレメトリ ストリームにログされ、認証要求を関連付けるためにアプリケーションによって使用されます。 これは、すべてのアプリケーションがこのテレメトリ ストリームにアクセスできるわけではない場合でも、サインイン要求の関連付けに役立ちます。 Office Union や Teams などのアプリケーションは、このパラメータの代表的なユーザーです。
lw 0/1 注: この機能は非推奨です。 ライトウェイト サインアップを有効にします。 有効にした場合、ユーザーの地域に適用される法律で義務付けられている場合を除き、認証フローを通じてサインアップするユーザーは、名、姓、国、生年月日を入力する必要がなくなります。
fl phone2,
email,
wld,
wld2,
easi,
easi2		 注: この機能は非推奨です。 このパラメータは、サインアップ プロセス中に指定されるユーザー名オプションを制御します:
phone – ユーザー名を電話番号に制限します、
phone2 – 既定値は電話番号に設定されていますが、他のオプションを使用できます、
email – ユーザー名をメール (Outlook または EASI) に制限します、
wld – ユーザー名を Outlook に制限します、
–wld2 既定値は Outlook ですが、電話など、その他のオプションを使用できます、
easi – ユーザー名を EASI に制限します、
–easi2 既定値は EASI ですが、電話など、その他のオプションを使用できます。
nopa 0/1/2 注: この機能は非推奨です。 パスワードレス サインアップを有効にします。 値 1 を指定すると、パスワードなしでサインアップできますが、30 日後にパスワードの作成が強制されます。 値 2 を指定すると、パスワードなしで無期限にサインアップできます。 値 2 を使用するには、手動プロセスを使用してアプリを許可リストに追加する必要があります。
coa 0/1 注: この機能は非推奨です。 ユーザーの電話番号にコードを送信して、パスワードレス サインインを有効にします。 値 1 を使用するには、手動プロセスを使用してアプリを許可リストに追加する必要があります。
signup 0/1 [サインイン] ページではなく、[アカウントの作成] ページ内で認証フローを開始します。
fluent 0/1 注: この機能は非推奨です。 サインイン フローで新しい Fluent ルック アンド フィールを有効にします。 値 1 を使用するには、手動プロセスを使用してアプリを許可リストに追加する必要があります。
api-version “”/”2.0” 2.0 に設定した場合、このパラメータを使用すると、指定されたアプリ ID がこれを許可するように構成されている場合、clientid は Windows 呼び出しアプリによって登録されたものとは異なるアプリ ID を指定できます。
Clientid/client_id app ID 認証フローを呼び出すアプリのアプリ ID。
Client_uiflow new_account AccountsSettingsPane を呼び出さずに、アプリで新しいアカウントを追加できるようにします。 ForceAuthentication プロンプトの種類も渡す必要があります。 ForceAuthentication プロンプトの種類も渡す必要があります。

MSA 承認トークン パラメータ

パラメーター 値 メモ
scope String 承認およびトークン エンドポイントでクライアントによって要求されるアクセス許可の範囲を定義します。
claims String クライアント アプリケーションによって要求される省略可能な要求を指定します。
response_type String 承認プロセス フローを指定する OAuth 2.0 応答の種類の値を指定します。これには、それぞれのエンドポイントから返されるパラメータも含まれます。
phone String ホスト デバイスにリンクされている書式設定された電話番号のコンマ区切りの一覧を指定します。
qrcode_uri String 認証されたセッションを転送するための QR コード生成の要求では、この URL は QR コードに埋め込まれます。
Ttv 1/2 TBD
qrcode_state String QR コード作成要求では、この状態パラメータは、QR コード内に表示される URL に組み込まれます。
Child_client_id String 二重ブローカー フロー内の子クライアント アプリ ID。
child_redirect_uri String 二重ブローカー フローで使用される子クライアント アプリのリダイレクト URI。
safe_rollout String 要求に適用される安全なロールアウト計画を指定するために使用されるパラメータ。 アプリの所有者がアプリ構成の変更をロールアウトしていて、安全な展開のために変更を徐々に適用したい場合に便利です。
additional_scope String 認証サービスが 1 つの要求で追加の同意を収集できるように、追加のスコープを指定します。 これにより、クライアント アプリは、今後別のスコープを要求するときに、同意の中断を回避できます。
x-client-info I/O 値が 1.0 の場合、Client_info トークンが返されます。
challenge String 最初はリソース アプリによって提供され、変更されることなくクライアント アプリによって MSA サーバーに転送されます。
max_age 整数型 最大認証期間。 エンド ユーザーが最後に MSA によってアクティブに認証されてから許容される経過時間を秒単位で指定します。
mfa_max_age 整数型 ユーザーが MSA で多要素認証を最後に通過してから許容される経過時間を秒単位で指定します。
acr_values String 要求された認証コンテキスト クラス参照の値。 承認サーバーがこの認証要求の処理に使用するように要求されている acr 値を指定するスペース区切りの文字列。値は優先度順に表示されます。 実行された認証によって満たされた認証コンテキスト クラスが、acr 要求値として返されます。
redirect_uri String 応答が送信されるリダイレクト URI。 この URI は、MSA に事前登録されているクライアントのリダイレクト URI 値の 1 つと完全に一致する必要があります。
state String 要求とコールバックの間の状態を維持するために使用される不透明な値。
oauth2_response 1 1 に等しい場合、ws-trust 応答が OAuth 応答形式に従う必要があることを意味します。

関連項目