Permissões e segurança

As permissões definem o que uma API Key pode fazer.

Permissões

Permissão	Tipo	Finalidade
device:read	Somente leitura	Listar dispositivos, consultar detalhe de dispositivo, listar definições de tipo de dispositivo e consultar resultados de comandos
device:control	Escrita de comandos	Inclui todas as permissões de consulta de device:read e permite enviar comandos de relé, RS485 e outras operações aos dispositivos
device:config	Escrita de configuração	Inclui todas as permissões de consulta de device:read e permite alterar a configuração do dispositivo
device:manage	Gerenciamento	Inclui todas as permissões de consulta de device:read e permite adicionar dispositivos, removê-los e alterar suas senhas

Use as permissões mínimas exigidas pela sua integração.

Por exemplo:

Tipo de integração	Permissões recomendadas
Monitoramento ou sincronização de inventário	device:read
Integração com operação de dispositivos	device:control
Integração com configuração de dispositivos	device:config
Integração com gerenciamento de dispositivos	device:manage
Integração com controle completo	device:control, device:config, device:manage

Limites de acesso

• Todos os endpoints só podem acessar dispositivos que pertencem à sua conta
• device:manage habilita o gerenciamento de propriedade e senhas de dispositivo via REST API: adicionar dispositivos, removê-los e alterar suas senhas
• Se uma API Key tem autenticação válida mas falta a permissão exigida, as REST API retornam 403 AUTH_SCOPE_DENIED
• Se a autenticação estiver ausente, inválida ou expirada, as REST API retornam 401