claimsMappingPolicy リソースの種類

名前空間: microsoft.graph

重要

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

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

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

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

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

stsPolicy から継承します。

メソッド

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

プロパティ

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

要求マッピング ポリシー定義のプロパティ

次のプロパティは、要求マッピング ポリシーを表す JSON オブジェクトを形成します。 この 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 collection	このポリシーが適用されている directoryObject コレクション。 読み取り専用です。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": false,
}