optionalClaim 资源类型

命名空间:microsoft.graph

重要

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

包含与 应用程序关联的可选声明。 optionalClaims 资源的 idTokenaccessTokensaml2Token 属性是 optionalClaim 的集合。 如果受特定声明支持,还可以使用 additionalProperties 属性修改 optionalClaim 的行为。

有关详细信息,请参阅 为 Microsoft Entra 应用提供可选声明

属性

属性 类型 说明
additionalProperties 字符串集合 声明的其他属性。 如果此集合中存在属性,它将修改 name 属性中指定的可选声明的行为。
基本 布尔值 如果值为 true,则必须使用客户端指定的声明来确保最终用户请求的特定任务获得流畅的授权体验。 默认值为 false。
name String 可选声明的名称。
source String 声明的源 (目录对象) 。 扩展属性中有预定义声明和用户定义的声明。 如果源值为 null,则声明是预定义的可选声明。 如果源值为 user,则 name 属性中的值是用户对象的扩展属性。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "additionalProperties": ["String"],
  "essential": true,
  "name": "String",
  "source": "String"
}