Regras de Visibilidade

As regras de visibilidade presentes no API Manager têm o objetivo de restringir ou liberar o acesso de usuários e/ou times específicos a informações ou manipulação de determinados objetos do sistema.

Esses objetos são: APIs, ambientes e custom interceptors.

Opções de visibilidade

Embora os objetos (APIs, ambientes e custom interceptors) contenham especificidades relacionadas à visibilidade (que detalhamos no restante desta página), as opções e funcionamento em geral são iguais para todos os casos.

Há três opções de visibilidade encontradas em páginas de configuração dos objetos: Organisation, Teams e Only me. Cada uma delas define um escopo diferente para a liberação de acesso ao objeto em questão:

  • Organisation: o objeto estará visível para todos os usuários do sistema. Esta opção vem definida por padrão na criação de qualquer cadastro novo.

  • Teams: o objeto será visível somente para o time que for selecionado. Quando escolhida esta opção, um campo para a seleção do time será habilitado e será obrigatório definir um time (para saber mais sobre a criação de times, clique aqui).

  • Only me: o objeto será visível apenas para o usuário que o cadastrou.

Se você selecionar as opções Teams ou Only me quando configurando o acesso a qualquer um dos objetos, o botão Add Users será habilitado. Ao clicar nele, será exibida uma janela modal pela qual é possível adicionar usuários avulsos que também terão acesso ao objeto (vide imagens abaixo).

visibility add users button
visibility add users
O papel de acesso Super Admin possui permissão para visualizar e editar todas as funcionalidades (e objetos) existentes na Plataforma, independente da opção de visibilidade cadastrada para um dado objeto. Você pode ler mais sobre papéis de acesso (os roles) aqui.

Você pode ver abaixo as especificidades de regras de visibilidade para cada um dos objetos e alguns detalhes de funcionamento da Plataforma que têm relação com as opções de visibilidade cadastradas.

APIs

As opções de visibilidade para APIs são aplicadas no campo Context da tela de criação de uma nova API ou edição de uma API já cadastrada.

visibility api

Para as APIs, as regras de visibilidade se referem à permissão de edição e visualização dos objetos cadastrados.

Quando o botão Add Users for utilizado para dar acesso a usuários avulsos (habilitado nos casos de seleção das opções Teams ou Only me), você pode dar permissões de visualização somente (Can view) ou de visualização e edição (Can edit) para cada usuário.

visibility add users api
visibility add users api1

Ambientes (environments)

Na tela Environments, as regras de visibilidade se aplicam a dois campos diferentes das páginas de criação ou edição de um ambiente: Environment Deployment Permission e Environment Trace Visibility.

visibility environment

O campo Environment Deployment Permission está relacionado à permissão de implantação de APIs dentro do ambiente. As opções de visibilidade do campo restringem apenas a capacidade de um usuário realizar operações de deploy (implantação) das APIs, não afetando a visualização dos ambientes cadastrados ou edição de suas informações.

O campo Environment Trace Visibility permite restringir o acesso à visibilidade do ambiente no Trace (que contém a listagem de chamadas para as APIs implantadas no ambiente em questão).

Custom interceptors

No caso de interceptores personalizados, as opções de visibilidade são aplicadas no campo Visibility, presente na janela modal de criação ou edição de interceptores Java ou na tela de criação ou edição de interceptores JavaScript (vide imagens abaixo).

visibility js interceptor
visibility java interceptor

A seção de visibilidade dos custom interceptors só pode ser acessada através da página Interceptors, no menu principal do Manager. Quando o interceptor for editado através da seção Flows da página de criação ou edição de uma API, as regras de visibilidade não serão apresentadas.

Quando usuários são adicionados de forma avulsa (o que é possível nos casos de seleção das opções Teams ou Only me), eles terão permissão de edição dos interceptores.

Casos especiais

Há alguns casos específicos cujo comportamento, a respeito das regras de visibilidade, vale registrar.

  • Permissões do tipo Only me: quando um objeto for cadastrado com a opção de visibilidade Only me, demais usuários que tenham acesso ao objeto (por meio do botão Add Users), poderão editar a visibilidade — para organisation, teams ou adicionando usuários avulsos — mas não poderão escolher a opção only me. Isso impede que outros usuários se tornem proprietários do objeto.

  • Exclusão de um time vinculado a uma regra de visibilidade: caso um objeto possua uma regra de visibilidade do tipo teams e o time associado for excluído do Manager, a visibilidade do objeto será passada para Only me e somente o criador original terá permissão de acessar o objeto.

  • Exclusão de usuário que é proprietário de um objeto: caso o criador de um objeto seja excluído do Manager por outro usuário, o usuário que realizou a exclusão passará a ser o proprietário do objeto.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]