Permissionamento

Esta página está sendo constantemente atualizada com novos exemplos.

Esta página detalha os recursos e permissões disponíveis para controle de acesso no API Management (Sensedia Platform).

Conceitos Básicos

As definições a seguir são fundamentais para entender o funcionamento do permissionamento no API Management (Sensedia Platform):

  • Recurso: Representa uma área funcional do sistema, como APIs, Billing, Caches, etc.

  • Permissão (Permission): Ação específica permitida no recurso, como criar, deletar, listar, atualizar, visualizar, etc.

  • Papel (Role): Conjunto de permissões atribuídas a um usuário para definir seu nível de acesso.

Como funciona o permissionamento no API Management?

O permissionamento no API Management (Sensedia Platform) conta com mais granularização do que o realizado nas versões da API Platform 4.x. Isso significa que é possível ter um controle mais detalhado sobre as ações que cada usuário pode executar em cada recurso. Além de definir se um usuário poderá visualizar e/ou editar um recurso específico, também é possível especificar se ele poderá listar, criar, atualizar e/ou deletar os recursos.

Outra diferença em relação às versões da API Platform 4.x é que o gerenciamento de usuários, times, papéis e permissões se dá por meio do Sensedia Access Control. Nesse módulo, o permissionamento é realizado por meio de papéis (roles), que são conjuntos de permissões a serem atribuídas aos usuários. Ao criar um papel, você define quais permissões ele terá para cada recurso e, então, atribui esse papel aos usuários que precisam dessas permissões. Você também pode optar por utilizar os papéis padrão, que já vêm com permissões pré-definidas.

Para acesso a alguns recursos do API Management (ex.: Apis), será necessário também conceder permissões específicas de add-ons como o Access Control e o Analytics. Veja exemplos.

Abaixo, você pode consultar a relação entre recursos e permissões do API Management (Sensedia Platform) e também exemplos de configuração de papéis no Sensedia Access Control.

Recursos e respectivas permissões

A tabela abaixo apresenta todos os recursos e suas permissões possíveis para o API Management (Sensedia Platform):

Recurso Permissão

Access tokens

Access Token Create

Access Token List

Access Tokens Secret View

Access Token Update

Access Token View

Apis

API Create

API Delete

API List

API Update

API View

Apps

Application Create

Application Delete

Application List

Apps Secret View

Application Update

Application View

Billing

Billing List

Caches

Cache Create

Cache Delete

Cache List

Cache Update

Cache View

Certificates

Certificate Create

Certificate Delete

Certificate List

Certificate Update

Certificate View

Config

Config List

Config View

Connectors

Connector Create

Connector Delete

Connector List

Connector Update

Connector View

Deployment

Deployment Update

Environments

Environment Create

Environment Delete

Environment List

Environment Update

Environment View

Export

Export Data View

Gateway pools

Gateway-Pools List

Health checks

Health Check Create

Health Check Delete

Health Check List

Health Check Update

Health Check View

Import

Import Data Create

Inbound addresses

Inbound Address Create

Inbound Address Delete

Inbound Address List

Inbound Address Update

Inbound Address View

Interceptors

Interceptor Create

Interceptor Delete

Interceptor List

Interceptor Update

Interceptor View

OAuth config

OAuth Config Update

OAuth Config View

Plans

Plan Create

Plan Delete

Plan List

Plan Update

Plan View

Top operations

Top Operations List

Top Operations Show In Dev Portal

Trace

Trace List

Trace Decrypt View

Trace View

Contract

Read Contract

Create Contract

Documents

List Documents

Read Documents

Create Documents

Endpoints

Read Endpoints

Create Endpoints

Files

List Files

Create Files

Journey

Read Journey

Create Journey

Exemplos de configuração de papéis

Exemplo 1: Visualizar a listagem de APIs e suas informações

Estas são as permissões necessárias para que o usuário possa visualizar a listagem de APIs na tela API Catalog e também acessar as informações básicas de uma API na tela API Overview (acessada ao clicar em seu nome no card):

Produto Permissões necessárias

Access Control

List Groups

List Users from Group

View Group

List Groups from User

List Users

View User

API Platform

API List

API View

  • A permissão API List habilita o acesso à tela API Design  API Catalog.

  • A permissão API View permite visualizar as informações básicas das APIs e também habilita o download dos contratos e o acesso à respectiva Timeline.

Exemplo 2: Visualizar os traces das requisições

Com o conjunto de permissões listado abaixo, o usuário poderá acessar a lista de chamadas exibida na tela Trace and Health  General Trace, as requisições realizadas a uma API específica (tela API Trace) e os detalhes de chamadas específicas (Call Details):

Produto Permissões necessárias

Access Control

List Groups

List Users from Group

View Group

List Groups from User

List Users

View User

Analytics

General Calls View

General Trace View

API Platform

API List

API View

Trace List

Trace View

  • A permissão Trace List habilita o acesso às telas Trace and Health  General Trace e API Trace, enquanto que a permissão General Calls View possibilita visualizar os registros listados nessas telas.

  • As permissões General Trace View e Trace View habilitam a visualização dos detalhes de uma chamada específica (Call Details).
Thanks for your feedback!
EDIT

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