customClaimsPolicy リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリケーション管理者がこのポリシーの影響を受けるトークンで出力される要求をカスタマイズできるようにする要求ポリシーを表します。 このポリシーの詳細については、次の記事を参照してください。
- カスタム要求ポリシーを使用して要求をカスタマイズする (プレビュー)
- ポリシーを使用して要求のカスタマイズを行い、このポリシーと要求マッピング ポリシーの違いを確認する
エンティティ から継承します。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| Get | customClaimsPolicy | カスタム要求ポリシー オブジェクトのプロパティとリレーションシップを読み取ります。 |
| 作成または置換 | customClaimsPolicy | 新しいカスタム要求ポリシー オブジェクトが存在しない場合は作成するか、既存のカスタム要求ポリシー オブジェクトを置き換えます。 |
| Update | customClaimsPolicy | カスタム要求ポリシー オブジェクトのプロパティを更新します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| audienceOverride | String | 指定すると、WS-Federation および SAML2 プロトコルの対象ユーザー要求の内容がオーバーライドされます。 audienceOverride を適用するには、カスタム署名キーを使用する必要があります。それ以外の場合、audienceOverride 値は無視されます。 指定する値は、絶対 URI の形式である必要があります。 |
| 主張 | customClaim コレクション | 基本要求とコア要求セットに加えて、ポリシーの影響を受けるトークンに存在する要求を定義します。 customclaimbase から継承されます。 |
| id | String | ポリシー識別子の文字列。 エンティティから継承 されます。 |
| includeApplicationIdInIssuer | ブール型 | アプリケーション ID が要求に追加されるかどうかを示します。 これは、SAML2.0 とカスタム署名キーが使用されている場合にのみ関連します。 既定値は true。 省略可能。 |
| includeBasicClaimSet | ブール型 | このポリシーの影響を受けるトークンに基本的な要求セットが含まれるかどうかを判断します。
trueに設定されている場合、基本要求セット内のすべての要求は、ポリシーの影響を受けるトークンで生成されます。 既定では、このポリシーで明示的に構成されていない限り、基本要求セットはトークンに含まれません。 |
リレーションシップ
なし。
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.customClaimsPolicy",
"id": "String (identifier)",
"includeBasicClaimSet": "Boolean",
"includeApplicationIdInIssuer": "Boolean",
"audienceOverride": "String",
"groupFilter": {
"@odata.type": "microsoft.graph.groupClaimFilterBase"
},
"claims": [
{
"@odata.type": "microsoft.graph.customClaim"
}
]
}