Skip to main content

Autenticação 2 Fatores

Cadastro de uma nova chave A2F

POST: https://api4.oystr.com.br/v1/service/vault/totp
{
    "bot": "sample",
    "name": "chavedeexemplo",
    "url": "otpauth://totp/chavedeexemplo?algorithm=SHA1&digits=6&period=30&secret=GQ7FWN3CIM4D6OKRF53TKTZFMI7HGSSQ",
    "username": "12312312312"
}

Este endpoint irá cadastrar uma chave de autenticação 2 fatores para um usuário.

  • Tipo requisição: POST;
  • Tipo resposta: SÍNCRONA;
  • Body: json
Parâmetro Tipo Descrição
bot String (obrigatório) Identificador interno do bot. Para cadastro de A2F do Projudi, utilize projudi-intimacao
name String (obrigatório) Nome que será atribuído a chave. Campo restringido a apenas caractéres de a - z (em minúsculo) e com tamanho máximo de 24 caractéres.
url String (obrigatório) URL no padrão otpauth para registro da chave secreta. A composição desta chave irá contemplar o nome da chave informada no campo name e também a chave secreta no padrão (todos os caractéres em maiúsculo e sem espaçamento, por exemplo: GQ7FWN3CIM4D6OKRF53TKTZFMI7HGSSQ)
username String (obrigatório) Identificador do usuário na plataforma que irá utilizar esse cadastro A2F. Em caso de tribunal como Projudi, normalmente é o CPF contendo apenas digitos, sem espaçamento e . -.

 

Listando todas as chaves A2F

GET: https://console4.oystr.com.br/api/v1/service/vault/totp

Este endpoint irá listar todas as chaves de autenticação 2 fatores para uma conta.

  • Tipo requisição: GET;
  • Tipo resposta: SÍNCRONA;
  • Resposta: json