Referência de escopos OAuth
Os escopos OAuth são a camada 1 do modelo de segurança: eles definem quais famílias de operações seu aplicativo OAuth tem permissão de executar. Esta página lista todos os escopos e o que cada um concede.
Escopos
Seção intitulada “Escopos”| Escopo | Concede |
|---|---|
read:basic | Lê informações básicas de perfil, organização e descoberta de API. Necessário para GET /oauth/api-info; veja o aviso abaixo. |
read:hierarchy | Lê nós de dados e a hierarquia de sites. |
write:hierarchy | Renomeia, move ou exclui nós de dados. |
read:bundle | Lê data bundles, seu status de processamento e os arquivos de entrada. |
write:bundle | Cria data bundles e gerencia seus envios e processamento. |
read:poi | Lê pontos de interesse (POIs). |
write:poi | Cria, atualiza ou exclui pontos de interesse (POIs). |
read:zone | Lê zonas. |
write:zone | Cria, atualiza ou exclui zonas. |
read:asset | Lê RealityAssets e tipos de ativo. |
write:asset | Cria, atualiza ou exclui RealityAssets e seus metadados. |
search:objects | Pesquisa objetos de negócio (ativos, POIs, zonas) em um twin. |
read:twin | Lê espaços de twin e de reality plan, bundles e layouts. |
write:twin | Cria ou atualiza rascunhos de twin. |
download:sitefile | Obtém uma URL de download assinada para um arquivo de site. |
write:sitefile | Cria e envia arquivos de site. |
download:scan | Reservado; atualmente não controla o acesso a nenhum endpoint. |
read:assetlibrary | Lê modelos e etiquetas da Asset Library. |
write:assetlibrary | Cria, atualiza ou exclui modelos e etiquetas da Asset Library. |
download:assetlibrary | Obtém links de download assinados ou miniaturas de um modelo da Asset Library. |
read:assetsettings | Lê as configurações de ativo. |
write:assetsettings | Reservado; atualmente não controla o acesso a nenhum endpoint. |
read:user | Lê usuários. |
write:user | Cria, atualiza ou exclui usuários. |
read:invitation | Lê convites. |
write:invitation | Cria convites. |
Próximos passos
Seção intitulada “Próximos passos”- Explore a referência da API para conhecer o escopo exato exigido por cada operação.