Validar contrato de API para os padrões initiate+validate ou validate only

Editar online

O recurso validate é chamado por componentes internos do Verify durante um desafio de Autenticação de diversos fatores de tempo de execução quando o fator que é usado suporta os padrões de integração "initiate+validate" ou "validate only".

Por exemplo, um smsotp ou um totp. Verify espera que a resposta contenha um status que indique o sucesso ou a falha da tentativa de solicitação de validação. O exemplo a seguir ilustra uma solicitação de amostra enviada ao initiateVerify 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 '/validate' \
'Content-Type: application/json' \
'Accept: application/json' \

{
  "capability":  "<<factor capability name, e.g. totp>>",
  "id": "<<factor or device identifier from external provider>>",
  "transactionId": "<<provider transaction identifier>>"
  "attributes":
    {
      "passvalue": "806795",
      "username": "<<external MFA username>>"
    }
}
Observação: O caminho /validateHTTP neste exemplo varia de acordo com a configuração do webhook.

Validar detalhes da solicitação

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 representa o token ou valor de passagem a ser validado. A carga útil também identifica o usuário e sua inscrição ou registro de Autenticação de diversos fatores associado.
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. Identifica o tipo de capacidade do fator de Autenticação de diversos fatores. 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.
transactionId

Opcional. Identificador de estado de desafio de autenticação de provedor de Autenticação de diversos fatores ou transação. Este valor está presente se a validação é realizada como parte do fluxo de padrão "initiate+validate". Seu valor é o mesmo que foi incluído na resposta anterior "initiate".
attributes

Obrigatório. Validar atributos adicionais específicos de solicitação.
attributes.username

Obrigatório. O nome de um usuário no sistema provedor externo para o qual a validação é solicitada.
attributes.passvalue

Obrigatório. O token ou valor a ser validado.
O código a seguir é uma carga útil de resposta de amostra validate.
{
    "attributes": {
        "<<any name>>": "<<any value>>"
    },
    "status": "SUCCESS"
}

Validar detalhes de resposta

Elementos Descrição
Tipo de carga útil Um objeto JSON que representa o status de tentativa de validação.
Código de Status HTTP Veja o status do HTTP.
status Obrigatório. O status de conclusão de validação. Os valores válidos incluem SUCCESS, PENDING, TIMEOUT, CANCELED e FAILED
attributes Opcional. Atributos adicionais que são retornados para o cliente Verify público que acionou o desafio da Autenticação de diversos fatores. Quaisquer atributos e valores adicionais podem estar presentes.