identityApiConnector tipo de recurso

Namespace: microsoft.graph

Representa os conectores de API nos inquilinos do Microsoft Entra.

Um conector de API utilizado nos fluxos de utilizador de inscrição self-service do ID Externo do Microsoft Entra permite-lhe chamar uma API durante a execução do fluxo de utilizador. Um conector de API fornece as informações necessárias para chamar uma API, incluindo um URL de ponto final e autenticação. Um conector de API pode ser utilizado num passo específico num fluxo de utilizador para afetar a execução do fluxo de utilizador. Por exemplo, a resposta da API pode impedir um utilizador de se inscrever, mostrar um erro de validação de entrada ou substituir atributos recolhidos pelo utilizador.

Utilize a API b2xIdentityUserFlow para utilizar um conector de API de um fluxo de utilizador de inscrição self-service de Identidades Externas.

Métodos

Método	Tipo de retorno	Descrição
List	Coleção identityApiConnector	Obter uma lista de conectores de API
Create	Coleção identityApiConnector	Crie um novo conector de API.
Get	Coleção identityApiConnector	Leia as propriedades de um objeto identityApiConnector .
Atualizar	Coleção identityApiConnector	Atualize as propriedades de um conector de API.
Carregar um certificado de cliente	Coleção identityApiConnector	Carregue um certificado de cliente para utilizar para autenticação.
Delete	Nenhum	Eliminar um conector de API.

Propriedades

Propriedade	Tipo	Descrição
authenticationConfiguration	apiAuthenticationConfigurationBase	O objeto que descreve os detalhes de configuração da autenticação para chamar a API. O certificado de cliente Básico e PKCS 12 é suportado.
displayName	Cadeia de caracteres	O nome do conector da API.
id	Cadeia de caracteres	O identificador gerado aleatoriamente do conector da API.
targetUrl	Cadeia de caracteres	O URL do ponto final da API a chamar.

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

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