名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
特定のアプリケーションに発行されたトークンに対する WS-Fed、SAML、OAuth 2.0、および OpenID Connect プロトコルの要求マッピング ポリシーを表します。 要求マッピング ポリシーを使用して、次のことができます。
- トークンに含めるクレームを選択する
- まだ存在しないクレームの種類を作成する
- 特定のクレームで出力されるデータのソースを選択または変更する
トークン サイズを小さくするために、要求マッピング ポリシーに追加できる要求と変換の数は制限されています。 制限に達した後に発生した要求、スキーマのエントリ、または変換は無視され、発行されたトークンには含まれません。 制限の詳細については、「 要求マッピング ポリシー定義のプロパティ」を参照してください。
stsPolicy から継承します。
その他のシナリオと構成の詳細については、次の記事を参照してください。
- Microsoft Entra 管理センターを通じて、テナント内の特定のアプリのトークンで発行される要求をカスタマイズします。
- 方法: Microsoft Graph の要求マッピング ポリシーを使用して要求をカスタマイズします。
- ポリシーを使用した要求のカスタマイズ このポリシーと カスタム クレーム ポリシーの違いを確認します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | claimsMappingPolicy | claimsMappingPolicies オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Create | claimsMappingPolicy | claimsMappingPolicy オブジェクトを作成します。 |
| Get | claimsMappingPolicy | claimsMappingPolicy オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | なし | claimsMappingPolicy オブジェクトを更新します。 |
| Delete | なし | claimsMappingPolicy オブジェクトを削除します。 |
| 一覧表示の適用対象 | directoryObject コレクション | このポリシーが適用される directoryObjects の一覧を取得します。 |
| サービス プリンシパルに割り当てる | なし | servicePrincipal オブジェクトに claimsMappingPolicy を割り当てます。 |
| サービス プリンシパルに割り当てられた一覧 | claimsMappingPolicy コレクション | servicePrincipal オブジェクトに割り当てられている claimsMappingPolicy オブジェクトを一覧表示します。 |
| サービス プリンシパルからの割り当てを解除する | なし | servicePrincipal オブジェクトから claimsMappingPolicy を削除します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| id | 文字列 | このポリシーの一意識別子。 読み取り専用です。 |
| definition | String collection | このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、「 要求マッピング ポリシー定義のプロパティ」を参照してください。 必須です。 |
| displayName | 文字列 | このポリシーの表示名。 必須です。 |
| isOrganizationDefault | ブール型 | このプロパティは無視します。 要求マッピング ポリシーはサービス プリンシパルにのみ適用でき、organizationに対してグローバルに設定することはできません。 |
要求マッピング ポリシー定義のプロパティ
定義プロパティに挿入する JSON オブジェクトは、最初に引用符をエスケープした文字列に変換する必要があります。 このセクションでは、定義の例をいくつか示します。
例 : トークン 内のクレームとして EmployeeID と TenantCountry を含める定義
{
"definition": [
"{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"employeeid\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\",\"JwtClaimType\":\"name\"},{\"Source\":\"company\",\"ID\":\"tenantcountry\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country\",\"JwtClaimType\":\"country\"}]}}"
],
"displayName": "Test1234"
}
例: クレーム変換を使用する定義
{
"definition": [
"{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\"},{\"Source\":\"user\",\"ID\":\"givenname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname\"},{\"Source\":\"user\",\"ID\":\"displayname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\"},{\"Source\":\"user\",\"ID\":\"surname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname\"},{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"username\"}],\"ClaimsTransformation\":[{\"ID\":\"CreateTermsOfService\",\"TransformationMethod\":\"CreateStringClaim\",\"InputParameters\": [{\"ID\":\"value\",\"DataType\":\"string\", \"Value\":\"sandbox\"}],\"OutputClaims\":[{\"ClaimTypeReferenceId\":\"TOS\",\"TransformationClaimType\":\"createdClaim\"}]}]}}"
],
"displayName": "Test1234"
}
| プロパティ | 型 | 説明 |
|---|---|---|
| バージョン | 整数 | 設定値を 1 に設定します。 必須です。 |
| IncludeBasicClaimSet | ブール型 |
true に設定すると、基本クレーム セットに含まれるすべてのクレームが、ポリシーの影響を受けるトークンで出力されます。
false に設定すると、基本クレーム セットに含まれるクレームは、同じポリシーの ClaimsSchema プロパティに個別に追加されない限り、トークンには含まれません。 |
| ClaimsSchema | JSON オブジェクト | 基本的なクレーム セットとコア クレーム セットに加えて、ポリシーの影響を受けるトークンに存在するクレームを定義します。 このプロパティで定義されているクレーム スキーマ エントリごとに、特定の情報が必要です。 データの送信元 (値またはソース/ID のペア) と、どのクレームとしてデータを出力するか (クレームの種類) を指定します。 ClaimsSchema オブジェクトを通じてトークンには、最大 50 個のクレームが含まれます。 制限に達した後に発生した要求スキーマ エントリは無視され、発行されたトークンには表示されません。 詳細については、要求のカスタマイズに使用されるポリシーのClaimsSchema 定義とプロパティを参照してください。 |
| ClaimsTransformation | JSON オブジェクト | ClaimsSchema で指定されたクレームの出力データを生成するために、ソース データに適用できる一般的な変換を定義します。 ClaimsTransformation オブジェクトを通じて、最大 50 個の変換がトークンに含まれます。 制限に達した後に発生した変換は無視され、発行されたトークンには表示されません。 ClaimsTransformation とサポートされている関数の詳細については、「 要求の変換」を参照してください。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| appliesTo | directoryObject コレクション | このポリシーが適用される directoryObject コレクション。 読み取り専用です。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"definition": ["String"],
"displayName": "String",
"id": "String (identifier)",
"isOrganizationDefault": false,
}