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

Тип ресурса identityApiConnector

  • Статья

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

Важно!

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

Представляет соединители API в идентификаторе Microsoft Entra и клиентах Azure AD B2C.

Соединитель API, используемый в самостоятельной регистрации внешнего идентификатора Microsoft Entra и пользовательских потоках регистрации Azure AD B2C, позволяет вызывать API во время выполнения потока пользователя. Соединитель API предоставляет сведения, необходимые для вызова API, включая URL-адрес конечной точки и проверку подлинности. Соединитель API можно использовать на определенном этапе в потоке пользователя, чтобы повлиять на выполнение потока пользователя. Например, ответ API может заблокировать регистрацию пользователя, отобразить ошибку проверки входных данных или перезаписать атрибуты, собранные пользователем.

Используйте API b2xIdentityUserFlow , чтобы использовать соединитель API из потока пользователя самостоятельной регистрации внешних удостоверений.

Методы

Метод Тип возвращаемых данных Описание
Список коллекция identityApiConnector Получение списка соединителей API
Создание identityApiConnector Создайте соединитель API.
Получение identityApiConnector Чтение свойств объекта identityApiConnector .
Обновление identityApiConnector Обновление свойств соединителя API.
Отправка сертификата клиента identityApiConnector Отправьте сертификат клиента для проверки подлинности.
удаление; Нет Удаление соединителя API.

Свойства

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

Связи

Отсутствуют.

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

В следующем представлении JSON показан тип ресурса.

{
  "@odata.type": "#microsoft.graph.identityApiConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "targetUrl": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
  }
}