claimsMappingPolicy リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

特定のアプリケーションに発行されたトークンの WS-Fed、SAML、OAuth 2.0、OpenID Connect プロトコルの要求マッピング ポリシーを表します。 クレーム マッピング ポリシーを使用すると、次のことができます。

• トークンに含める要求を選択する
• まだ存在しない要求の種類を作成する
• 特定の要求で出力されるデータのソースを選択または変更する

要求マッピング ポリシーに追加できる要求と変換の数は、トークン のサイズを小さくするために制限されます。 制限に達した後に検出された要求スキーマ エントリまたは変換は無視され、発行されたトークンに含まれます。 制限の詳細については、「クレーム マッピング ポリシー定義のプロパティ」を参照してください。

シナリオと構成の詳細については、「 要求マッピング ポリシーの種類 」と「 方法: テナント内の特定のアプリのトークンで出力される要求をカスタマイズする」を参照してください。

stsPolicy から継承します。

メソッド

メソッド	戻り値の型	説明
List	claimsMappingPolicy	claimsMappingPolicies オブジェクトのプロパティとリレーションシップを読み取ります。
Create	claimsMappingPolicy	claimsMappingPolicy オブジェクトを作成します。
Get	claimsMappingPolicy	claimsMappingPolicy オブジェクトのプロパティとリレーションシップを読み取ります。
Update	なし	claimsMappingPolicy オブジェクトを更新します。
Delete	なし	claimsMappingPolicy オブジェクトを削除します。
一覧表示の適用対象	directoryObject コレクション	このポリシーが適用されている directoryObjects の一覧を取得します。
サービス プリンシパルに割り当てる	なし	claimsMappingPolicy を servicePrincipal オブジェクトに割り当てます。
サービス プリンシパルに割り当てられた一覧	claimsMappingPolicy コレクション	servicePrincipal オブジェクトに割り当てられている claimsMappingPolicy オブジェクトを一覧表示します。
サービス プリンシパルからの割り当てを解除する	なし	servicePrincipal オブジェクトから claimsMappingPolicy を削除します。

プロパティ

プロパティ	型	説明
id	String	このポリシーの一意識別子。 読み取り専用です。
definition	String collection	このポリシーの規則と設定を定義する JSON 文字列を含む文字列コレクション。 このプロパティの JSON スキーマの詳細については、「 クレーム マッピング ポリシー定義のプロパティ」を参照してください。 必須です。
displayName	String	このポリシーの表示名。 必須です。
isOrganizationDefault	ブール型	このプロパティは無視します。 要求マッピング ポリシーは、サービス プリンシパルにのみ適用でき、組織に対してグローバルに設定することはできません。

クレーム マッピング ポリシー定義のプロパティ

定義プロパティに挿入する 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,
}