optionalClaims 资源类型

命名空间：microsoft.graph

重要

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

声明应用程序请求的可选声明。 应用程序可以将可选声明配置为在三种类型的令牌中返回， (ID 令牌、访问令牌、SAML 2 令牌，) 它可以从安全令牌服务接收。 应用程序可以配置要在每个令牌类型中返回的不同可选声明集。 应用程序的 optionalClaims 属性是 optionalClaims 对象。

应用程序开发人员可以在其Microsoft Entra应用中配置可选声明，以指定他们希望在 Microsoft 安全令牌服务发送到其应用程序的令牌中哪些声明。 有关详细信息，请参阅向 Microsoft Entra 应用提供可选声明。

属性

属性	类型	说明
idToken	optionalClaim 集合	JWT ID 令牌中返回的可选声明。
accessToken	optionalClaim 集合	JWT 访问令牌中返回的可选声明。
saml2Token	optionalClaim 集合	SAML 令牌中返回的可选声明。

JSON 表示形式

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

{
  "idToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
  "accessToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
  "saml2Token": [{"@odata.type": "microsoft.graph.optionalClaim"}]
}