API Reference

Listar usuários

get
{protocol}://{host}/service/admin/api/v4/users

Realiza envio de requisição para consulta de usuários.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

O que precisa saber antes de usar este serviço?

Se você ainda não viu, acesse a documentação de negócios: Listar usuários

Query Params
string
enum

Podem ser consultados os usuários a partir do modo de autenticação que realizam acesso no ambiente. (Oauth, SAML, LDAP, SSO)

Allowed:
string

Pode ser consultado o usuário a partir do e-mail completo cadastrado para o usuário no ambiente.

boolean

Podem ser consultados os usuários a partir do Status sendo ativo ou inativo no ambiente. (True ou False)

boolean

Podem ser consultados os usuários a partir da permissão de acesso sendo um usuário administrativo ou não no ambiente.
(true = usuário perfil “administrativo”
false = usuário perfil “não administrativo”
(--) vazio = todos os usuários)

boolean

Podem ser consultados os usuários a partir da Permissão BPM do cadastro do usuário sendo um usuário externo ou não no ambiente.
(true = usuário perfil “externo”
false = usuário perfil “não externo”
(--) vazio = todos os usuários)

boolean

Podem ser consultados usuários a partir de Permissões BPM do cadastro de usuário se pode "Alterar Processos" no ambiente.
(true = usuário com permissão para alterar processos
false = usuário sem permissão para alterar processos
(--) vazio = todos os usuários)

string

Poder ser consultados os usuários com usuário líder configurado no cadastro.
Ao informar o líder, pode ser utilizado tanto o nome quanto o login do usuário líder, descrevendo o nome completo ou parte dele.

string

Pode ser consultado usuário a partir do seu login completo.

boolean

Podem ser consultados usuários configurados como master ou não.
A configuração de usuário “master” não há apresentação gráfica no ambiente e refere-se à configuração de usuários do sistema criados no momento que o ambiente é implantado.
(true = usuário perfil “master”
false = usuário perfil “padrão”
(--) vazio = todos os usuários)

string

Pode ser consultado um usuário, descrevendo o nome completo ou parte dele.

integer

O campo page serve para definir qual página será retornada com os dados correspondentes.
Pode ser usado associado ao campo size, que define quantos elementos serão retornados por página.
Quando não for informado nenhum valor ou o valor inserido for inválido, automaticamente o valor será 0.

integer

O campo size é associado ao campo page e define quantos resultados serão retornados por página.
Quando não for informado nenhum valor ou o valor inserido for inválido, automaticamente o valor será 20.

string
enum

Podem ser consultados os usuários a partir do status configurado no ambiente.
(BLOQUEADOS = usuários bloqueados no ambiente
INATIVO = usuários inativos no ambiente
ATIVO = usuários ativos no ambiente
PENDENTE = usuários com pendências de cadastro a partir de importação AD/LDAP)

Allowed:
string

Podem ser consultados os usuários que contenham no seu cadastro um usuário substituto. Ao informar o substitute, pode ser utilizado tanto o nome quanto o login do usuário substituto, descrevendo o nome completo ou parte dele.

date

Podem ser consultados os usuários que estão em férias na data definida desse parâmetro. O valor deve seguir o padrão yyyy-MM-dd.

string

Pode ser consultado um usuário, descrevendo o npumero do celular cadastrado para ele.

Headers
string
required

Deve ser informado o domínio do ambiente onde será retornada a listagem de usuários.

Response

Updated over 2 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8

Updated over 2 years ago