TOTP

Pré-requisitos:

  • ID de uma Política válida.
  • Provedor de Autenticação válido associado a política selecionada.
  • Credenciais de Admin ou Client ID + Access Key
  • Aplicativo Compatível com padrão da RFC do TOTP, exemplos: Google Authenticator, Microsoft Authenticator, etc.

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

Enrollment

URL de Documentação da API : /apidocs/#/totp/post_totp__policyId__enrollment

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 TOTP.
  • 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 solicitar a criação de semente 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/totp/$POLICY_ID/enrollment" \
      -d '{"username": "john"}'
    
  • Portal de APIs: Enrollment de TOTP

No retorno desta chamada terá uma imagem em base64 ao transformar de base64 para imagem, será apresentado um QRCode, basta scanear com o aplicativo compatível.


Verify

URL de Documentação da API : /apidocs/#/totp/post_totp__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 TOTP.
  • 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 testar a autenticação no provedor de autenticação
  • otp:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: Caminho da URL (Path)
    • Descrição: O token gerado no aplicativo.
  • 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/totp/$POLICY_ID/verify" \
      -d '{"username": "john", "otp": "$OTP"}'
    
  • Portal de APIs: Verificação de TOTP


Delete

URL de Documentação da API : /apidocs/#/totp/post_totp__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 TOTP.
  • 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 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/totp/$POLICY_ID/delete" \
      -d '{"username": "john"}'
    
  • Portal de APIs: Deleção de TOTP

results matching ""

    No results matching ""