Referência de evento Extensão Personalizada para OnAttributeCollectionSubmit (versão prévia)

Aplica-se a: Locatários da força de trabalho Locatários externos (saiba mais)

Para modificar a experiência de inscrição para os fluxos de usuário de inscrição de autoatendimento do cliente, você pode criar uma extensão de autenticação personalizada e invocá-la em pontos específicos no fluxo do usuário. O evento OnAttributeCollectionSubmit ocorre depois que o usuário insere e envia atributos e pode ser usado para validar as informações fornecidas pelo usuário. Por exemplo, você pode validar um código de convite ou número de parceiro, modificar um formato de endereço, permitir que o usuário continue ou mostrar uma página de validação ou bloqueio. As seguintes ações podem ser configuradas:

• continueWithDefaultBehavior – Continue com o fluxo de inscrição.
• modifyAttributeValues – Substitua os valores enviados pelo usuário no formulário de inscrição.
• showValidationError – Retornar um erro com base nos valores enviados.
• showBlockPage – Mostra uma mensagem de erro e impedir que o usuário se inscreva.

Este artigo descreve o esquema da API REST para o evento OnAttributeCollectionSubmit. (Consulte também o artigo relacionado Extensão Personalizada para o evento OnAttributeCollectionSubmit.)

Esquema da API REST

Para desenvolver sua própria API REST para o evento de envio da coleção de atributos, use o seguinte contrato de dados da API REST. O esquema descreve o contrato para criar o manipulador de solicitações e respostas.

Sua extensão de autenticação personalizada no Microsoft Entra ID faz uma chamada HTTP para sua API REST com um conteúdo JSON. O conteúdo JSON contém dados de perfil do usuário, atributos de contexto de autenticação e informações sobre o aplicativo ao qual o usuário deseja entrar. Os atributos JSON podem ser usados por sua API para executar uma lógica adicional.

Solicitar à API REST externa

A solicitação para sua API REST está no formato mostrado abaixo. Neste exemplo, a solicitação inclui informações de identidades de usuário, juntamente com atributos internos (givenName e companyName) e atributos personalizados (universityGroups, graduationYear e onMailingList).

A solicitação contém os atributos de usuário selecionados no fluxo de usuário para coleta durante a inscrição de autoatendimento, incluindo atributos internos (por exemplo, givenName e companyName) e atributos personalizados que já foram definidos (por exemplo, universityGroups, graduationYear e onMailingList). Sua API REST não pode adicionar novos atributos.

A solicitação também contém identidades de usuário, incluindo o email do usuário se ele foi usado como uma credencial verificada para se inscrever. A senha não é enviada. Para atributos com vários valores, os valores são enviados como uma cadeia de caracteres delimitada por vírgulas.

JSON

POST https://exampleAzureFunction.azureWebsites.net/api/functionName

{
  "type": "microsoft.graph.authenticationEvent.attributeCollectionSubmit",
  "source": "/tenants/aaaabbbb-0000-cccc-1111-dddd2222eeee/applications/<resourceAppguid>",
  "data": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitCalloutData",
    "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "authenticationEventListenerId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "customAuthenticationExtensionId": "11112222-bbbb-3333-cccc-4444dddd5555",
    "authenticationContext": {
        "correlationId": "<GUID>",
        "client": {
            "ip": "30.51.176.110",
            "locale": "en-us",
            "market": "en-us"
        },
        "protocol": "OAUTH2.0",
        "clientServicePrincipal": {
            "id": "<Your Test Applications servicePrincipal objectId>",
            "appId": "<Your Test Application App Id>",
            "appDisplayName": "My Test application",
            "displayName": "My Test application"
        },
        "resourceServicePrincipal": {
            "id": "<Your Test Applications servicePrincipal objectId>",
            "appId": "<Your Test Application App Id>",
            "appDisplayName": "My Test application",
            "displayName": "My Test application"
        },
    },
    "userSignUpInfo": {
      "attributes": {
        "givenName": {
          "@odata.type": "microsoft.graph.stringDirectoryAttributeValue",
          "value": "Larissa Price",
          "attributeType": "builtIn"
        },
        "companyName": {
          "@odata.type": "microsoft.graph.stringDirectoryAttributeValue",
          "value": "Contoso University",
          "attributeType": "builtIn"
        },
        "extension_<appid>_universityGroups": {
          "@odata.Type": "microsoft.graph.stringDirectoryAttributeValue",
          "value": "Alumni,Faculty",
          "attributeType": "directorySchemaExtension"
        },
        "extension_<appid>_graduationYear": {
          "@odata.type": "microsoft.graph.int64DirectoryAttributeValue",
          "value": 2010,
          "attributeType": "directorySchemaExtension"
        },
        "extension_<appid>_onMailingList": {
          "@odata.type": "microsoft.graph.booleanDirectoryAttributeValue",
          "value": false,
          "attributeType": "directorySchemaExtension"
        }
      },
      "identities": [
        {
          "signInType": "email",
          "issuer": "contoso.onmicrosoft.com",
          "issuerAssignedId": "larissa.price@contoso.onmicrosoft.com"
        }
      ]
    }
  }
}

Resposta da API REST externa

O Microsoft Entra ID espera uma resposta da API REST no formato a seguir. Os tipos de valor de resposta correspondem aos tipos de valor de solicitação, por exemplo:

• Se a solicitação contiver um atributo graduationYear com um @odata.type de int64DirectoryAttributeValue, a resposta deverá incluir um atributo graduationYear com um valor inteiro, como 2010.
• Se a solicitação contiver um atributo com vários valores especificados como uma cadeia de caracteres delimitada por vírgula, a resposta deverá conter os valores em uma cadeia de caracteres delimitada por vírgulas.

A ação continueWithDefaultBehavior especifica que sua API REST externa está retornando uma resposta de continuação.

HTTP/1.1 200 OK

{
  "data": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitResponseData",
    "actions": [
      {
        "@odata.type": "microsoft.graph.attributeCollectionSubmit.continueWithDefaultBehavior"
      }
    ]
  }
}

A ação modifyAttributeValues especifica que sua API REST externa retorne uma resposta para modificar e substituir atributos com valores padrão depois que os atributos são coletados. Sua API REST não pode adicionar novos atributos. Todos os atributos extras retornados, mas que não fazem parte da coleção de atributos, são ignorados.

HTTP/1.1 200 OK

{
  "data": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitResponseData",
    "actions": [
      {
        "@odata.type": "microsoft.graph.attributeCollectionSubmit.modifyAttributeValues",
        "attributes": {
          "key1": "value1,value2,value3",
          "key2": true
        }
      }
    ]
  }
}

A ação showBlockPage especifica que sua API REST externa está retornando uma resposta de bloqueio.

HTTP/1.1 200 OK

{
  "data": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitResponseData",
    "actions": [
      {
        "@odata.type": "microsoft.graph.attributeCollectionSubmit.showBlockPage",
        "message": "Your access request is already processing. You'll be notified when your request has been approved."
      }
    ]
  }
}

A ação showValidationError especifica que sua API REST está retornando um erro de validação e um código de status e mensagem apropriados.

HTTP/1.1 200 OK

{
  "data": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitResponseData",
    "actions": [
      {
        "@odata.type": "microsoft.graph.attributeCollectionSubmit.showValidationError",
        "message": "Please fix the below errors to proceed.",
        "attributeErrors": {
          "city": "City cannot contain any numbers",
          "extension_<appid>_graduationYear": "Graduation year must be at least 4 digits"
        }
      }
    ]
  }
}