claimsMappingPolicy 资源类型

命名空间：microsoft.graph

表示 WS-Fed、SAML、OAuth 2.0 和 OpenID Connect 协议的声明映射策略，用于颁发给特定应用程序的令牌。 可以使用声明映射策略来：

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

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

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

此外，请访问 使用策略的声明自定义 ，了解此策略与 自定义声明策略之间的差异。

继承自 stsPolicy。

方法

方法	返回类型	Description
List	claimsMappingPolicy	读取 claimsMappingPolicies 对象的属性和关系。
创建	claimsMappingPolicy	创建 claimsMappingPolicy 对象。
Get	claimsMappingPolicy	读取 claimsMappingPolicy 对象的属性和关系。
更新	无	更新 claimsMappingPolicy 对象。
删除	None	删除 claimsMappingPolicy 对象。
列表适用于	directoryObject collection	获取已应用此策略的 directoryObject 列表。
分配到服务主体	None	将 claimsMappingPolicy 分配给 servicePrincipal 对象。
分配给服务主体的列表	claimsMappingPolicy 集合	列出分配给 servicePrincipal 对象的 claimsMappingPolicy 对象。
取消从服务主体分配	None	从 servicePrincipal 对象中删除 claimsMappingPolicy。

属性

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

声明映射策略定义的属性

要插入 到定义 属性中的 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"
}

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

关系

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

JSON 表示形式

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

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