Cadastro de autenticação

De RBX ISP - Manual do Usuário

O objetivo deste serviço é criar uma nova autenticação. Abaixo, segue exemplo do json de envio:

{
  "authentication_insert":
  {
    "customer_id": 22563, 
    "contract_id": 65874,
    "nas": "-2",
    "port": "-2",
    "user": "joaozinho",
    "password": "s6c5e87s8s5s",
    "mac": "",
    "allow_access_subscriber_center": true,
    "allow_update_password": false,
    "force_password_update": false,
    "profile_id": 0,
    "comments": "texto livre",
    "status": "A"
  }
}

Detalhamento dos campos

ID Campo Obrigatório Pai Tipo Observações
A01 Dados da autenticação Sim Raiz -  
A02 customer_id Sim A01 Número

Código do cliente

A03 contract_id Sim A01 Número

Número do contrato

A04 nas Sim A01 Texto

IP interno do NAS (para NAS cadastrado no sistema) ou um dos valores abaixo para NAS virtuais:

  • -1: (TODOS)
  • -2: (CENTRAL DO ASSINANTE)
  • -3: (APRENDER)
A05 port Sim A01 Texto

Porta do NAS informado no campo anterior. Portas virtuais:

  • -1: (TODAS)
  • -3: (APRENDER)
A06 user Sim A01 Texto

Usuário da autenticação

A07 password Não A01 Texto

Senha da autenticação

A08 mac Não A01 Texto

MAC válido, no formato ##:##:##:##:##:##

A09 allow_access_subscriber_center Sim A01 Booleano

Define se esta autenticação terá acesso à Central do Assinante.

  • true: tem acesso
  • false: não tem acesso
A10 allow_update_password Sim A01 Booleano

Define se esta autenticação poderá ter sua senha alterada através da Central do Assinante.

  • true: permite alteração
  • false: não permite alteração
A11 force_password_update Sim A01 Booleano

Define se a senha deverá ser alterada no primeiro acesso do usuário através da Central do Assinante.

  • true: deverá ser alterada
  • false: não precisará ser alterada
A12 profile_id Não A01 Número

Código de um dos perfis de acesso à central do assinante.

A13 comments Não A01 Texto

Texto livre.

A14 status Sim A01 Texto

Situação da autenticação. Valores permitidos:

  • A: Ativo
  • I: Inativo

 

Mensagem de retorno

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

{
  "status": 1,
  "error_code": 0,
  "error_description": "",
  "result":
    {
       "id": 22
    }
}

Em caso de falha, será retornado um json conforme o exemplo abaixo:

{
  "status": 0,
  "error_code": 12,
  "error_description": "The field status is invalid!",
  "result": ""
}