Тип ресурса identityApiConnector

Статья
10/21/2023

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

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

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

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

Методы

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

Свойства

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

Связи

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

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

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

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