Тип ресурса claimsMappingPolicy

Статья
03/15/2023

Пространство имен: microsoft.graph

Представляет политики сопоставления утверждений для протоколов WS-Fed, SAML, OAuth 2.0 и OpenID Connect для маркеров, выданных конкретному приложению. Политики сопоставления утверждений можно использовать для:

Выбор утверждений, включенных в маркеры
Создание еще не существующих типов утверждений
Выбор или изменение источника данных, выдаваемых в определенных утверждениях

Количество утверждений и преобразований, которые можно добавить в политику сопоставления утверждений, ограничено для уменьшения размера маркера. Все записи схемы утверждений или преобразования, возникающие после достижения ограничения, игнорируются и включаются в выданный маркер. Дополнительные сведения об ограничениях см. в разделе Свойства определения политики сопоставления утверждений.

Дополнительные сведения о сценарии и конфигурации см . в разделах Тип политики сопоставления утверждений и Практическое руководство. Настройка утверждений, создаваемых в маркерах для определенного приложения в клиенте.

Наследует от stsPolicy.

Методы

Метод	Возвращаемый тип	Описание
Создание claimsMappingPolicy	claimsMappingPolicy	Создайте объект claimsMappingPolicy.
Получение claimsMappingPolicy	claimsMappingPolicy	Чтение свойств и связей объекта claimsMappingPolicy.
Перечисление типов ресурсов claimsMappingPolicy	claimsMappingPolicy	Чтение свойств и связей объектов claimsMappingPolicies.
Обновление claimsMappingPolicy	Нет	Обновление объекта claimsMappingPolicy.
Удаление claimsMappingPolicy	Нет	Удаление объекта claimsMappingPolicy.
Объекты каталога
Список appliesTo	Коллекция directoryObject	Получите список объектов каталога, к которым применена эта политика.
Назначение типа ресурса claimsMappingPolicy	Нет	Назначьте объект claimsMappingPolicy объекту servicePrincipal .
Список назначенных утвержденийMappingPolicy	Коллекция claimsMappingPolicy	Список объектов claimsMappingPolicy, назначенных объекту servicePrincipal .
Удаление типа ресурса claimsMappingPolicy	Нет	Удалите claimsMappingPolicy из объекта servicePrincipal .

Свойства

Свойство	Тип	Описание
Определение	Коллекция строк	Коллекция строк, содержащая строку JSON, которая определяет правила и параметры для этой политики. Дополнительные сведения о схеме JSON для этого свойства см. в разделе Свойства определения политики сопоставления утверждений . Обязательно.
displayName	String	Отображаемое имя для этой политики. Обязательный.
id	String	Уникальный идентификатор для этой политики. Только для чтения.
isOrganizationDefault	Логический	Игнорировать это свойство. Политика сопоставления утверждений может применяться только к субъектам-службам и не может быть задана глобально для организации.

Свойства определения политики сопоставления утверждений

Приведенные ниже свойства формируют объект 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"
}

Свойство	Тип	Описание
ClaimsSchema	Объект JSON	Определяет, какие утверждения присутствуют в маркерах, на которые влияет политика, в дополнение к базовому набору утверждений и набору основных утверждений. Для каждой записи схемы утверждений, определенной в этом свойстве, требуются определенные сведения. Укажите, откуда поступают данные (пара "Значение" или "Источник-идентификатор") и утверждение, в котором данные выдаются как (тип утверждения). Не более 50 утверждений включаются в маркер через объект ClaimsSchema. Все записи схемы утверждений, возникающие после достижения ограничения, будут игнорироваться и не будут отображаться в выданном маркере. Дополнительные сведения см. в определении ClaimsSchema.
ClaimsTransformation	Объект JSON	Определяет общие преобразования, которые можно применить к исходным данным для создания выходных данных для утверждений, указанных в ClaimsSchema. Через объект ClaimsTransformation в маркер включается не более 50 преобразований. Все преобразования, возникающие после достижения ограничения, будут игнорироваться и не будут отображаться в выданном маркере. Дополнительные сведения о ClaimsTransformation и поддерживаемых функциях см. в разделе Преобразование утверждений.
IncludeBasicClaimSet	Логический	Если задано значение `true`, все утверждения в базовом наборе утверждений создаются в маркерах, на которые влияет политика. Если задано значение `false`, утверждения в базовом наборе утверждений не входят в маркеры, если они не добавляются по отдельности в свойство ClaimsSchema той же политики.
Версия	Integer	Задайте значение 1. Обязательный.

Связи

Связь	Тип	Описание
appliesTo	Коллекция directoryObject	Коллекция directoryObject , к которому применена эта политика. Только для чтения.

Представление JSON

Ниже указано представление ресурса в формате JSON.

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