Alteração de Status do Usuário

Este endpoint permite a alteração do status de um usuário na plataforma.

Os possíveis status do usuário são:

  • A = Ativo

  • C = Cancelado

  • I = Inativo

  • S = Suspenso

  • P = Pendente Aceite (utilizado apenas quando o cadastro do usuário for orgânico, por exemplo, cadastrado pelo aplicativo por conta própria)

Endpoint

PUT /api/v1/integracao/usuario/alterar/:{cpf}

  • cpf (string, obrigatório): O CPF do usuário cujo status será alterado.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

status

string

O novo status do usuário. Valores permitidos: A, C, S, P, I

Response

{
  "message": "Status do usuário atualizado com sucesso",
  "usuario": {
    "cpf": "12345678909",
    "status": "A"
  }
}

Notas

  • Certifique-se de que o CPF fornecido esteja no formato correto e seja válido.

  • O token Bearer deve ser incluído em todas as requisições para acessar os endpoints protegidos.

  • O status do usuário deve ser um dos valores permitidos (A, C, S, P, I).

Respostas ao usuário no aplicativo

Status Pendente Ativação (P)

Título: Não foi possível validar seu login Mensagem: Seu cadastro está pendente ativação.

Descrição: O usuário verá essa mensagem se o cadastro estiver pendente de ativação. O acesso à aplicação não será permitido até que o cadastro seja ativado pelo administrador do sistema.

Status Inativo (I)

Título: Não foi possível validar seu login Mensagem: Seu cadastro está inativo.

Descrição: O usuário verá essa mensagem se o cadastro estiver inativo. O acesso à aplicação não será permitido enquanto o cadastro estiver inativo.

Status Cancelado (C)

Título: Não foi possível validar seu login Mensagem: Seu cadastro está cancelado.

Descrição: O usuário verá essa mensagem se o cadastro estiver cancelado. O acesso à aplicação não será permitido enquanto o cadastro estiver cancelado.

Status Suspenso (S)

Título: Não foi possível validar seu login Mensagem: Seu cadastro está suspenso, entre em contato com o suporte.

Descrição: O usuário verá essa mensagem se o cadastro estiver suspenso. O acesso à aplicação não será permitido enquanto o cadastro estiver suspenso. É recomendado que o usuário entre em contato com o suporte para resolver o problema.

Last updated