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 de versão.

Representa conectores de API em um Azure Active Directory (Azure AD) e locatários do Azure AD B2C.

Um conector de API usado na sua assinatura de autoatendados de Identidades Externas do Azure AD e fluxos de usuário de entrada do Azure AD B2C permite que você chame uma API durante a execução do fluxo de usuários. 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 do usuário. Por exemplo, a resposta da API pode impedir que um usuário se inscreve, 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 autoatendência de Identidades Externas.

Métodos

Método	Tipo de retorno	Descrição
List	Coleção identityApiConnector	Obter uma lista de conectores de API
Criar	identityApiConnector	Crie um novo conector de API.
Obter	identityApiConnector	Leia as propriedades de um objeto identityApiConnector.
Atualizar	identityApiConnector	Atualize as propriedades de um conector de API.
Carregar certificado do cliente	identityApiConnector	Carregar 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 da API.
displayName	Cadeia de caracteres	O nome do conector da API.
targetUrl	Cadeia de caracteres	A URL do ponto de extremidade da API a ser chamada.
authenticationConfiguration	apiAuthenticationConfigurationBase	O objeto que descreve os detalhes de configuração de autenticação para chamar a API. Certificado cliente básico e PKCS 12 são suportados.

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"
  }
}