OTP

Pré-requisitos:

  • ID de uma Política válida.
  • Provedor de Autenticação válido associado a política selecionada.
  • Provedor de Notificação válido associado a política selecionada.
  • Base de Usuários válida assocada a política selecionada.
  • Credenciais de Admin ou Client ID + Access Key

O mecanismo de OTP possui 3 operações básicas, Create, Verify e Delete.


Create

URL de Documentação da API : /apidocs/#/otp/post_otp__policyId__create

Parâmetros:

  • policyId:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: Caminho da URL (Path)
    • Descrição: O ID da Política que será utilizada na operação de OTP.
  • username:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O nome do usuário que o MFAO irá utilizar para procurar as informações necessários para notificação na UserStore e para criar o OTP no provedor de autenticação.
  • notification:
    • Obrigatório: Não
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O ID do provedor de Notificação atrelado a Política selecionado, caso não seja informado, irá utilizar o Default.
  • verbose:
    • Obrigatório: Não
    • Tipo: Booleano
    • Localização: No corpo da requisição JSON.
    • Descrição: Caso o valor seja true, irá retornar diversar métricas sobre a requisição e resposta, default=false.

Exemplos:

  • Curl:
      curl -X POST \
      -H 'content-type: application/json' \
      -H 'api-key: $API_KEY' \
      -H 'access-key: $ACCESS_KEY' \
      "https://authfy-mfao.example/api/otp/$POLICY_ID/create" \
      -d '{"username": "john"}'
    
  • Portal de APIs: Criação de OTP


Verify

URL de Documentação da API : /apidocs/#/otp/post_otp__policyId__verify

Parâmetros:

  • policyId:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: Caminho da URL (Path)
    • Descrição: O ID da Política que será utilizada na operação de OTP.
  • username:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O nome do usuário que o MFAO irá utilizar para validar o OTP recebido no provedor de autenticação.
  • otp:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O token enviado para o usuário via Out-of-Band.
  • verbose:
    • Obrigatório: Não
    • Tipo: Booleano
    • Localização: No corpo da requisição JSON.
    • Descrição: Caso o valor seja true, irá retornar diversar métricas sobre a requisição e resposta, default=false.

Exemplos:

  • Curl:
      curl -X POST \
      -H 'content-type: application/json' \
      -H 'api-key: $API_KEY' \
      -H 'access-key: $ACCESS_KEY' \
      "https://authfy-mfao.example/api/otp/$POLICY_ID/verify" \
      -d '{"username": "john", "otp": "$OTP"}'
    
  • Portal de APIs: Verificação de OTP


Delete

URL de Documentação da API : /apidocs/#/otp/post_otp__policyId__delete

Parâmetros:

  • policyId:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: Caminho da URL (Path)
    • Descrição: O ID da Política que será utilizada na operação de OTP.
  • username:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O nome do usuário que o MFAO irá utilizar para deletar a semente do usuário no provedor de autenticação.
  • verbose:
    • Obrigatório: Não
    • Tipo: Booleano
    • Localização: No corpo da requisição JSON.
    • Descrição: Caso o valor seja true, irá retornar diversar métricas sobre a requisição e resposta, default=false.

Exemplos:

  • Curl:
      curl -X POST \
      -H 'content-type: application/json' \
      -H 'api-key: $API_KEY' \
      -H 'access-key: $ACCESS_KEY' \
      "https://authfy-mfao.example/api/otp/$POLICY_ID/delete" \
      -d '{"username": "john"}'
    
  • Portal de APIs: Deleção de OTP

results matching ""

    No results matching ""