Obter authenticationListener

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.

Obter a autenticação especificadaListener definida para o evento onSignupStart no pipeline de autenticação.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante)	Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration
Delegado (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration

Solicitação HTTP

GET /identity/events/onSignupStart/{id}

Parâmetros de consulta opcionais

Este método dá suporte ao parâmetro de consulta OData para expandir os detalhes $expand de um invokeUserFlowListener. Confira abaixo um exemplo. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se tiver êxito, este método retornará um código 200 OK de resposta e um objeto authenticationListener no corpo da resposta.

Exemplos

Exemplo 1: Obter um authenticationListener por id

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/identity/events/onSignupStart/{id}

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "odata.context": "https://graph.microsoft.com/beta/$metadata#identity/events/onSignUpStart/$entity",
  "@odata.type": "#microsoft.graph.invokeUserFlowListener",
  "id": "2adb5c12-5c12-2adb-125c-db2a125cdb2a",
  "priority": 101,
  "sourceFilter": {
      "includeApplications": [
          "3dfff01b-0afb-4a07-967f-d1ccbd81102a"
      ]
   }
}

Exemplo 2: Expanda invokeUserFlowListener para uma autenticação específicaListener

O exemplo a seguir obtém o ouvinte por id do evento onSignupStart e expande o fluxo de usuário invocado.

Solicitação

Este é um exemplo de solicitação.

GET https://graph.microsoft.com/beta/identity/events/onSignupStart/{id}?$expand=microsoft.graph.invokeUserFlowAction/userFlow

Resposta

Este é um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/events/onSignUpStart(microsoft.graph.invokeUserFlowListener/userFlow())/$entity",
  "@odata.type": "#microsoft.graph.invokeUserFlowListener",
  "id": "2adb5c12-5c12-2adb-125c-db2a125cdb2a",
  "priority": 101,
  "sourceFilter": {
      "includeApplications": [
          "3dfff01b-0afb-4a07-967f-d1ccbd81102a"
      ]
  },
  "userFlow": {
      "id": "B2X_1_Partner",
      "userFlowType": "signUpOrSignIn",
      "userFlowTypeVersion": 1
  }
}