Contrato da API de consulta de matrículas

Editar online

Praticamente toda integração externa de MFA deve permitir que o ISV Verify identifique todos os fatores de MFA disponíveis no momento para um usuário específico. Quando executado, Verify o programa espera que a resposta contenha uma lista de objetos JSON, em que cada objeto identifica e representa uma funcionalidade de autenticação multifatorial (MFA) do usuário.

O exemplo a seguir ilustra uma solicitação de amostra enviada ao enrollmentsVerify recurso do webhook em tempo real. Dependendo da configuração do webhook, essa mesma carga útil pode ser enviada diretamente para o provedor de Autenticação de diversos fatores de destino ou transformada em uma solicitação de cliente de API aceitável para o provedor de destino.

POST '/enrollments' \
'Content-Type: application/json' \
'Accept: application/json' \

{
    "username": "<<external MFA username>>"
}

Observação: O caminho /enrollmentsHTTP neste exemplo varia de acordo com a configuração do webhook.

Detalhes da solicitação de consulta de matrículas

Elemento	Descrição
HTTP Request	POST
Cabeçalho HTTP - Tipo de conteúdo	O tipo de conteúdo da carga útil da é sem solicitação é sempre `application/json`.
Cabeçalho HTTP - Aceitar	O tipo de conteúdo que se espera da carga útil de resposta é sempre `application/json`.
payload	Um objeto JSON que identifica o usuário para o qual as inscrições são solicitadas.
nome de usuário	Obrigatório. O nome do usuário no sistema do provedor externo para o qual são solicitados os dados de inscrição.

O exemplo a seguir é um exemplo de uma enrollment lookup carga útil de resposta.

[
    {
        "attributes": {
            "authExecutionFlow": "init_then_poll",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. push>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "init_then_validate",
            "deliveryAddress": "<<e.g. phone number or email address>>",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. smsotp>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "validate",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. totp>>",
        "id": "<<factor or device identifier from external provider>>"
    }
]

Detalhes da resposta da consulta de matrículas

Elementos	Descrição
Tipo de carga útil	Uma matriz JSON de inscrições externas na autenticação multifatorial (MFA).
Código de Status HTTP	Veja o status do HTTP.
`id`	Obrigatório. O identificador exclusivo do recurso de fator de Autenticação de diversos fatores inscrito ou registrado do usuário.
`capability`	Obrigatório. O valor é sequência de caracteres válidos. Ele deve corresponder a um dos recursos configurados para o provedor de Autenticação de diversos fatores associado ao webhook.
`attributes`	Obrigatório. Os atributos adicionais que são retornados ao cliente público Verify que acionou a consulta de cadastro. Podem existir mais atributos e valores.
`attributes.authExecutionFlow`	Obrigatório. Informa Verify sobre o `MFA pattern` que é suportado pela capacidade do fator. Valores válidos incluem: `validate` - validar apenas o padrão. `init_then_validate` - Inicie o padrão de validação. `init_then_poll` - Padrão de iniciar e aguardar a conclusão. Este atributo é utilizado pela interface Verify de usuário/experiência do usuário (UI/UX) e pela estrutura de desafio de autenticação multifatorial (MFA) externa para controlar a execução em tempo de execução.
`attributes.deliveryAddress`	Opcional. Se o padrão de execução incluir o envio de um token de MFA ou uma experiência semelhante, esse atributo será exibido durante Verify a seleção do usuário de MFA. Esse padrão pode ajudar e orientar o usuário na escolha entre as opções de autenticação multifatorial (MFA) disponíveis.
`attributes.deviceName`	Opcional. Se o padrão de execução incluir um processo de entrega de token de MFA ou, de alguma forma, incluir algum tipo de dispositivo ou token de autenticação separado de propriedade do usuário, esse atributo será exibido durante a seleção do usuário para Verify MFA. Esse padrão pode ajudar e orientar o usuário na escolha entre as opções de autenticação multifatorial (MFA) disponíveis.