Usuários | Central de Ajuda

Endpoints de administração/consulta de usuários da plataforma.

Todas as requisições exigem o cabeçalho Authorization — veja Autenticação e Segurança.

Índice desta página

Buscar Usuários

Permite buscar usuários através dos parâmetros usados como filtro.

Request

GET https://api.cvortex.com/v1/users/search

Header: Authorization

Parâmetros de URI

Nome	Tipo	Descrição	Obrigatório
`active`	boolean	Usuário ativo	Não
`limit`	number	Quantidade de registros por página. Valor máximo permitido: 100	Não
`offset`	number	Número de registros saltados no resultado da página	Não
`sort-fields`	text	Campo usado para ordenação, no formato `<nome do campo>:ASC\|DESC`. Exemplo: `username:ASC`	Não

Response

Código	Descrição
200	Operação realizada com sucesso

JSON

[
  {
    "id": "string",
    "deleted": "boolean",
    "createdAt": "integer (int64)",
    "updatedAt": "integer (int64)",
    "active": "boolean",
    "createdBy": "string",
    "updatedBy": "string",
    "version": "string",
    "personId": "string",
    "email": "string",
    "username": "string"
  }
]

Exemplo

GET https://api.cvortex.com/v1/users/search?active=true&limit=5&sort-fields=username:ASC

JSON

[
  {
    "id": "8f00f389-e988-4f35-8f73-93c500701589",
    "deleted": false,
    "createdAt": 1654719964555,
    "active": true,
    "createdBy": "default-user",
    "version": "0",
    "personId": "7fba8f3b-6de4-4772-a374-0bc79bdc62bd",
    "email": "email@empresas.com",
    "username": "nome.sobrenome"
  }
]

Contar usuários

Permite contar usuários através dos parâmetros usados como filtros.

Request

GET https://api.cvortex.com/v1/users/count

Header: Authorization

Parâmetros de URI

Nome	Tipo	Descrição	Obrigatório
`active`	text	Filtra usuários pelo estado ativo/inativo	Sim

Response

Código	Descrição
200	Operação realizada com sucesso

number

Exemplo

GET https://api.cvortex.com/v1/users/count?active=true

Ativar usuários

Permite ativar um usuário.

Request

POST https://api.cvortex.com/v1/users/{id}/activate

Header: Authorization

Parâmetros de URI

Nome	Tipo	Descrição	Obrigatório
`id`	string	Identificador do usuário a ser ativado	Sim

Response

Código	Descrição
200	Operação realizada com sucesso

Exemplo

POST https://api.cvortex.com/v1/users/3639722f-5dd7-4435-9fd6-ccf71ce2f900/activate

Inativar usuários

Permite inativar um usuário.

Request

POST https://api.cvortex.com/v1/users/{id}/inactivate

Header: Authorization

Parâmetros de URI

Nome	Tipo	Descrição	Obrigatório
`id`	string	Identificador do usuário a ser inativado	Sim

Response

Código	Descrição
200	Operação realizada com sucesso

Exemplo

POST https://api.cvortex.com/v1/users/3639722f-5dd7-4435-9fd6-ccf71ce2f900/inactivate