Skip to content

Editar grupo​

PUT
/tenant/groups

Altera um grupo do Tenant, identificado por id. Só os campos enviados mudam, e cada lista enviada substitui a anterior inteira.

Campo Efeito
nome Nome do grupo
bi_desks Mesas de Aplicação liberadas, por ID
apps_deny Aplicações Bloqueadas, por ID
users Membros, por login (e-mail). Só usuário que já está no Tenant
tables Tabelas liberadas ao grupo, com filtro de linha. Tabela fora da lista perde a liberação; num item já liberado, campo omitido mantém o valor

O filtro de linha vai em tables: cada item libera uma tabela, com os filtros, as colunas ocultas e a permissão de exportar. Não precisa de Datamart, e a liberação feita por Datamart não muda com este campo. Exemplos em Filtrar as linhas de cada usuário.

Para pôr ou tirar um membro, mande a lista inteira com ou sem ele. Usuário administrado pelo fornecedor da plataforma continua no grupo mesmo fora da lista.

A API não altera o grupo Administradores nem grupo administrado pelo fornecedor.

Mensagens de erro

A alteração para no primeiro erro, e o que veio antes dele no corpo já ficou gravado.

Mensagem Status Causa
ID do grupo é obrigatório 400 Campo id não enviado
Grupo não encontrado 404 ID não existe ou não pertence ao tenant
O grupo de administrador não pode ser editado pela API. 403 Grupo Administradores
Este grupo é administrado pelo fornecedor da plataforma... 403 Grupo que a API não altera
App {id} não encontrado 404 ID em apps_deny não existe
Mesa de aplicação {id} não encontrada 404 ID em bi_desks não existe
Usuário {login} não encontrado 404 Login não existe ou não está no tenant
O usuário {login} é administrado pelo fornecedor da plataforma... 403 Login de usuário que a API não altera
Liberação de tabela inválida: ... 400 Item de tables com coluna de outra tabela, operador sem o valor que pede ou tabela que não é do tenant (TABLE_ACCESS_INVALID)

Autorizações​

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Corpo da Requisição​

application/json
JSON

Respostas​

Operação processada

application/json
JSON

Playground​

Autorização
Corpo

Exemplos​

Desenvolvido por VitePress OpenAPI