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


Обновление identityApiConnector

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

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

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

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

Разрешения

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

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

Важно!

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

HTTP-запрос

PATCH /identity/apiConnectors/{identityApiConnectorId}

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

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

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

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

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

Свойство Тип Описание
displayName String Имя соединителя API.
targetUrl String URL-адрес вызываемой конечной точки API.
authenticationConfiguration apiAuthenticationConfigurationBase Объект , описывающий сведения о конфигурации проверки подлинности для вызова API. Поддерживаются только обычная проверка подлинности и сертификат клиента PKCS 12 .

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content.

Примеры

Пример 1. Изменение отображаемого имени, targetUrl и имени пользователя & пароля, используемого для обычной проверки подлинности

Запрос

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

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/{identityApiConnectorId}
Content-Type: application/json

{
  "displayName": "New Test API",
  "targetUrl": "https://otherapi.com/api/endpoint",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.basicAuthentication",
    "username":"<NEW_USERNAME>", 
    "password":"<NEW_PASSWORD>"
  }
}

Отклик

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

HTTP/1.1 204 No Content

Пример 2. Изменение соединителя API для использования проверки подлинности сертификата клиента

Это приведет к перезаписи всех предыдущих параметров authenticationConfiguration. Чтобы сменить обычную проверку подлинности на проверку подлинности с помощью сертификата, используйте эту команду. Чтобы добавить дополнительные сертификаты в список сертификатов, используйте метод Отправить сертификат клиента . При использовании этого метода последующие операции Get или List соединителей authenticationConfiguration API будут иметь тип microsoft.graph.clientCertificateAuthentication.

Запрос

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

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/be1f769b-9b13-437e-b540-79a905c4932c
Content-Type: application/json

{
  "authenticationConfiguration": {
    "@odata.type": "#microsoft.graph.pkcs12Certificate",
    "pkcs12Value": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ...kDJ04sJShkkgjL9Bm49plA",
    "password": "secret"
  }
}

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content