Поделиться через

Обновление samlOrWsFedExternalDomainFederation

  • Статья

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновите свойства объекта samlOrWsFedExternalDomainFederation .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

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

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) IdentityProvider.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение IdentityProvider.ReadWrite.All Недоступно.

В делегированных сценариях с рабочими или учебными учетными записями вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Администратор внешнего поставщика удостоверений — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

PATCH directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/{samlOrWsFedExternalDomainFederation ID}

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса предоставьте объект JSON с одним или несколькими свойствами, которые необходимо обновить для объекта samlOrWsFedExternalDomainFederation в клиенте Microsoft Entra.

В следующей таблице показаны свойства, которые можно обновить для объекта samlOrWsFedExternalDomainFederation .

Свойство Тип Описание
displayName String Отображаемое имя поставщика удостоверений на основе SAML/WS-Fed. Унаследовано от identityProviderBase.
issuerUri String URI издателя сервера федерации. Наследуется от samlOrWsFedProvider.
metadataExchangeUri String URI конечной точки обмена метаданными, используемой для проверки подлинности из расширенных клиентских приложений. Наследуется от samlOrWsFedProvider.
passiveSignInUri String URI, на который направляются веб-клиенты при входе в службы Microsoft Entra. Наследуется от samlOrWsFedProvider.
preferredAuthenticationProtocol String Предпочтительный протокол проверки подлинности. Поддерживаемые значения: saml или wsfed. Наследуется от samlOrWsFedProvider.
signingCertificate String Текущий сертификат, используемый для подписи маркеров, передаваемых на платформу удостоверений Майкрософт. Сертификат имеет формат строки в кодировке Base64 общедоступной части сертификата подписи маркера федеративного поставщика удостоверений и должен быть совместим с классом X509Certificate2.

Это свойство используется в следующих сценариях:
  • Значение , если требуется откат за пределами автоматического обновления
  • настраивается новая служба федерации
  • Значение , если новый сертификат подписи маркера отсутствует в свойствах федерации после обновления сертификата службы федерации.


Microsoft Entra ID обновляет сертификаты с помощью процесса автоматической регистрации, в котором пытается получить новый сертификат из метаданных службы федерации за 30 дней до истечения срока действия текущего сертификата. Если новый сертификат недоступен, Microsoft Entra ID ежедневно отслеживает метаданные и обновляет параметры федерации для домена при появлении нового сертификата.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект samlOrWsFedExternalDomainFederation в тексте ответа.

Примеры

Запрос

PATCH https://graph.microsoft.com/beta/directory/federationConfigurations/graph.samlOrWsFedExternalDomainFederation/d5a56845-6845-d5a5-4568-a5d54568a5d5
Content-Type: application/json

{
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed"
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/json

{
 "id": "d5a56845-6845-d5a5-4568-a5d54568a5d5",
  "displayName": "Contoso name change",
  "issuerUri": "http://contoso-test.com/adfs/services/trust",
  "metadataExchangeUri": null,
  "signingCertificate": "M66C6DCCAdCgAwIBAgIQQ6vYJIVKQ",
  "passiveSignInUri": "https://contoso-test.com/adfs/ls/",
  "preferredAuthenticationProtocol": "wsFed",
  "domains": [
      {
          "id": "contoso.com"
      }
  ]
}