大网数据广告活动
Microsoft Graph 接口

claimsMappingPolicy 资源类型

· 52CE 我爱测

表示 WS-Fed、SAML、OAuth 2.0 和 OpenID 连接协议的声明映射策略,用于颁发给特定应用程序的令牌。

命名空间:microsoft.graph

表示 WS-Fed、SAML、OAuth 2.0 和 OpenID 连接协议的声明映射策略,用于颁发给特定应用程序的令牌。 可以使用声明映射策略执行以下操作:

  • 选择令牌中包含的声明
  • 创建尚不存在的声明类型
  • 选择或更改在特定声明中发出的数据源

可添加到声明映射策略的声明和转换数目限制为减少令牌大小。 达到限制后遇到的任何声明架构条目或转换将被忽略,并包含在颁发的令牌中。 有关限制的详细信息,请参阅 声明映射策略定义的属性

有关更多方案和配置详细信息,请参阅 声明映射策略类型 和 操作方法:自定义租户中特定应用的令牌中发出的声明。

继承自 stsPolicy。

方法

方法 返回类型 说明
创建 claimsMappingPolicy claimsMappingPolicy 创建 claimsMappingPolicy 对象。
获取 claimsMappingPolicy claimsMappingPolicy 读取 claimsMappingPolicy 对象的属性和关系。
列出 claimsMappingPolicies claimsMappingPolicy 读取 claimsMappingPolicies 对象的属性和关系。
更新 claimsMappingPolicy 无 更新 claimsMappingPolicy 对象。
删除 claimsMappingPolicy 无 删除 claimsMappingPolicy 对象。
目录对象
List appliesTo directoryObject collection 获取已应用此策略的 directoryObjects 的列表。
分配 claimsMappingPolicy 无 将 claimsMappingPolicy 分配给 servicePrincipal 对象。
列出分配的声明MappingPolicy claimsMappingPolicy 集合 列出分配给 servicePrincipal 对象的 claimsMappingPolicy 对象。
删除 claimsMappingPolicy 无 从 servicePrincipal 对象中删除 claimsMappingPolicy。

属性

属性 类型 说明
id String 此策略的唯一标识符。 只读。
定义 String collection 包含 JSON 字符串的字符串集合,用于定义此策略的规则和设置。 有关此属性的 JSON 架构的更多详细信息,请参阅 声明映射策略定义 的属性。 必需。
description String 此策略的说明。
displayName String 此策略的显示名称。 必填。
isOrganizationDefault Boolean 忽略此属性。 声明映射策略只能应用于服务主体,不能为组织全局设置。

声明映射策略定义的属性

下面的属性构成表示声明映射策略的 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 Boolean 如果设置为 true,基本声明集中的所有声明都会在受策略影响的令牌中发出。 如果设置为 false,基本声明集中的声明不在令牌中,除非它们单独添加到同一策略的 ClaimsSchema 属性中。
ClaimsSchema JSON 对象 定义受策略影响的令牌中存在哪些声明,以及基本声明集和核心声明集。 对于此属性中定义的每个声明架构条目,需要某些信息。 指定数据来自 (值或源/ID 配对) 的位置,以及将数据作为声明类型) 发出 (声明。 令牌中最多包含 50 个通过 ClaimsSchema 对象的声明。 达到限制后遇到的任何声明架构条目都将被忽略,并且不会显示在颁发的令牌中。 ClaimsSchema 定义中提供了更多详细信息。
ClaimsTransformation JSON 对象 定义可应用于源数据的常见转换,为 ClaimsSchema 中指定的声明生成输出数据。 通过 ClaimsTransformation 对象,令牌中最多包含 50 个转换。 达到限制后遇到的任何转换都将被忽略,并且不会显示在颁发的令牌中。 有关 ClaimsTransformation 和支持的函数的详细信息,请参阅 声明转换。

关系

关系 类型 说明
appliesTo directoryObject collection 已应用此策略 的 directoryObject 集合。 只读。

JSON 表示形式

下面是资源的 JSON 表示形式。

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

历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 paulgarn)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / Microsoft Graph 中文文档历史快照
适用范围
历史中文快照 2023-02-03;详见原文产品版本;文档日期 未标明
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。