tipo de recurso identityApiConnector

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa conectores de API em um Microsoft Entra ID e Azure AD locatários B2C.

Um conector de API usado no ID externa do Microsoft Entra inscrição de autoatendimento e Azure AD fluxos de usuário de inscrição B2C permite que você chame uma API durante a execução do fluxo de usuário. Um conector de API fornece as informações necessárias para chamar uma API, incluindo uma URL de ponto de extremidade e autenticação. Um conector de API pode ser usado em uma etapa específica em um fluxo de usuário para afetar a execução do fluxo de usuário. Por exemplo, a resposta à API pode impedir que um usuário se inscreva, mostrar um erro de validação de entrada ou substituir atributos coletados pelo usuário.

Use a API b2xIdentityUserFlow para usar um conector de API de um fluxo de usuário de inscrição de autoatendimento 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 certificado do cliente	Coleção identityApiConnector	Carregue um certificado de cliente a ser usado para autenticação.
Delete	Nenhum	Exclua um conector de API.

Propriedades

Propriedade	Tipo	Descrição
id	Cadeia de caracteres	A ID gerada aleatoriamente do conector de API.
displayName	Cadeia de caracteres	O nome do conector de API.
Targeturl	Cadeia de caracteres	A URL do ponto de extremidade da API a ser chamada.
authenticationConfiguration	apiAuthenticationConfigurationBase	O objeto que descreve os detalhes da configuração de autenticação para chamar a API. Há suporte para certificado de cliente básico e PKCS 12.

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

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