customClaimsPolicy 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示一个声明策略，该策略允许应用程序管理员自定义受此策略影响的令牌中发出的声明。

继承自 entity。

Methods

方法	返回类型	说明
Get	customClaimsPolicy	读取自定义声明策略对象的属性和关系。
创建或替换	customClaimsPolicy	创建新的自定义声明策略对象（如果不存在），或替换现有对象。
更新	customClaimsPolicy	更新自定义声明策略对象的属性。

属性

属性	类型	说明
audienceOverride	String	如果指定，它将替代 WS-Federation 和 SAML2 协议的受众声明的内容。 必须使用自定义签名密钥来应用 audienceOverride，否则将忽略 audienceOverride 值。 提供的值必须采用绝对 URI 的格式。
索赔	customClaim 集合	除了基本声明和核心声明集外，还定义受策略影响的令牌中存在的声明。 继承自 customclaimbase。
id	String	策略标识符字符串。 继承自 entity。
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"
    }
  ]
}