Usuários do grupo

Corresponde à aba Usuários, dentro da página de um grupo de acesso. Mostra os usuários daquele grupo e permite cadastrar um usuário já vinculado a ele. As regras de cadastro são as mesmas da página Usuários.

O grupo não precisa ser informado no corpo: ele vem do uuid na URL, access_group_uuid.

Endpoints

Método	Caminho	Descrição
GET	/administrative/access-groups/{access_group_uuid}/users	Lista os usuários do grupo
POST	/administrative/access-groups/{access_group_uuid}/users	Cadastra um usuário no grupo
PUT	/administrative/access-groups/{access_group_uuid}/users/{uuid}	Altera um usuário do grupo

Para apagar um usuário, use a página Usuários.

GET /administrative/access-groups/{access_group_uuid}/users

Lista os usuários do grupo, em ordem alfabética pelo nome, salvo se columnName e orderData forem informados.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre que busca no nome, no e-mail e no celular
name	Trecho do nome
email	Trecho do e-mail
online	Quando informado com valor verdadeiro, traz só os usuários online
columnName	Coluna para ordenar
orderData	Sentido da ordenação: asc ou desc
per_page	Quantidade de registros por página
page	Número da página, quando per_page é informado

Resposta (200): lista de usuários, direta ou paginada, com os mesmos campos de GET /administrative/users.

Exemplo:

curl https://api.pedagogo.app/administrative/access-groups/<uuid-do-grupo>/users \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /administrative/access-groups/{access_group_uuid}/users

Cadastra um usuário no grupo. Se a senha não for informada, o sistema gera uma senha de 8 caracteres e envia o e-mail de boas-vindas. Se o e-mail já pertencer a um usuário existente, esse cadastro é reativado e atualizado, como descrito em POST /administrative/users.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
name	Sim	Texto	Nome do usuário
email	Sim	E-mail	E-mail de acesso
cellphone	Não	Texto	Celular do usuário
password	Não	Texto	Senha de acesso. Se omitida, o sistema gera uma senha de 8 caracteres
department_id	Não	Número inteiro	id do departamento do usuário. Veja Departamentos

Resposta (201): o usuário criado, sem a senha.

Exemplo:

curl -X POST https://api.pedagogo.app/administrative/access-groups/<uuid-do-grupo>/users \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Usuário exemplo", "email": "[email protected]"}'

PUT /administrative/access-groups/{access_group_uuid}/users/{uuid}

Altera um usuário do grupo. Envie apenas os campos que devem mudar.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
name	Não	Texto	Nome do usuário
email	Não	E-mail	E-mail de acesso
cellphone	Não	Texto	Celular do usuário
password	Não	Texto	Nova senha. Ao informar uma senha, o sistema envia ao usuário um e-mail avisando da alteração
department_id	Não	Número inteiro	id do departamento do usuário

Resposta (200): o usuário alterado.