Iniciar contrato de API para o padrão initiate+validate e initiate+wait

Editar online

O recurso initiate é lançado por componentes internos 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 "initiate+wait" .

Por exemplo, um smsotp ou um push. Verify espera que a resposta contenha um status que indique o sucesso ou o falha da iniciação da Autenticação de diversos fatores e um identificador de transação incluído nas solicitações subsequentes "validate" ou "wait for result". 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 '/initiate' \
'Content-Type: application/json' \
'Accept: application/json' \

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

Iniciar 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. 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. Atributos adicionais específicos da solicitação.
attributes.username Obrigatório. O nome de um usuário no sistema de provedor externo para o qual a iniciação de Autenticação de diversos fatores é solicitada.
A amostra de código a seguir é um exemplo da carga útil de resposta initiate.
{
    "attributes": {
        "<<any name>>": "<<any value>>"
    },
    "status": "SUCCESS",
    "transactionId": "<<provider transaction identifier>>"
}

Iniciar detalhes de resposta

Elementos Descrição
Tipo de carga útil Um objeto JSON que representa o status de tentativa de iniciação da Autenticação de diversos fatores.
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
Nota: Retornar um status deSUCCESSA chamada para o Initiate resulta em um erro para o usuário final. SUCCESS não é um status válido para a chamada Initiate

Se o provedor de MFA suportar repetição da OTP, o 'status' deve aparecer como 'PENDENTE'.
transactionId

Obrigatório. Identificador de estado de desafio de autenticação de provedor de Autenticação de diversos fatores ou transação. Usado pelo provedor para correlacionar com quaisquer chamadas subsequentes de "validação" ou "pesquisa de resultado".
attributes

Opcional. Os atributos adicionais que são retornados ao cliente Verify público que acionou o desafio de Autenticação de diversos fatores. Quaisquer atributos e valores podem estar presentes.