Devices

Pré-requisitos:

  • ID de uma Política válida.
  • Provedor de Autenticação válido associado a política selecionada.
  • Apenas os provedores Authfy OTP e CA Strong Authentication são compatíveis com esta feature.
  • Credenciais de Admin ou Client ID + Access Key

A listagem e opt-out dos dispositivos de um usuário.

List

URL de Documentação da API : /apidocs/#/User_Devices/post_devices__policyId__list

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 listagem dos dispositivos.
  • 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 os dispositivos ao serviço 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/devices/$POLICY_ID/list" \
      -d '{"username": "john"}'
    

No retorno desta chamada terá uma lista com todos os dispositivos deste usuário.


Delete (Opt-out)

URL de Documentação da API : /apidocs/#/User_Devices/post_devices__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 deleção do dispositivo.
  • 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 e deletar o dispositivo
  • device:
    • Obrigatório: Sim
    • Tipo: String
    • Localização: No corpo da requisição JSON.
    • Descrição: O nome do dispositivo a ser deletado
  • 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/devices/$POLICY_ID/delete" \
      -d '{"username": "john", "device": "FIREFOX744"}'
    

results matching ""

    No results matching ""