Referência de permissões

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

A tabela a seguir lista as permissões que podem ser atribuídas a um papel usando a API Edge. Consulte Adicionar permissões ao papel de teste para um exemplo de como usar a API para definir a permissão de um papel.

Área do recurso URI de permissão Verbo Descrição

Google Analytics

Análise /environments/*/analytics/admin PUT Ativar análises para um ambiente (apenas nuvem privada)

Exportação de dados do Google Analytics

Exportação de dados /environments/*/analytics/exports GET, PUT Listar/criar job de exportação de dados
/environments/*/analytics/exports/* GET Receber status do job de exportação
/analytics/datastores GET, PUT Listar/criar repositórios de dados de análise
/analytics/datastores/* GET Acessar o repositório de dados de análise
/analytics/datastoreConsumers GET, PUT, DELETE Acessar/criar/excluir repositório de dados de análise

Modelos de API (somente nova interface)

Modelos de API /apimodels GET, PUT Listar/criar modelos de API
/apimodels/* GET, PUT, DELETE Acessar/atualizar/excluir modelo de API

Monitoramento de APIs (somente nova interface)

Monitoramento de APIs /apimonitoring GET, PUT, DELETE Listar/criar/excluir entidades de monitoramento da API

Pacotes de API (monetização)

Pacotes de API (monetização) /monetization-packages GET, PUT Listar/criar pacotes de API
/monetization-packages/* GET, PUT, DELETE Acessar/atualizar/excluir um pacote de API
/monetization-packages/*/products/* GET, PUT, DELETE Acessar/adicionar/excluir um produto de API em um pacote de API
/developers/*/monetization-packages GET Listar todos os pacotes de API aceitos por um desenvolvedor

Produtos de API

Produtos de API /apiproducts GET, PUT Listar/criar produtos de API
/apiproducts/* GET, PUT, DELETE Acessar/atualizar/excluir produto de API
Atributos do produto da API /apiproducts/*/attributes GET, PUT Listar/atualizar todos os atributos de produtos da API
/apiproducts/*/attributes/* GET, PUT, DELETE Acessar/atualizar/excluir atributo do produto da API

Proxies de API

Proxies de API /applications GET, PUT Listar/criar proxies de API
/applications/* GET, PUT, DELETE Acessar/atualizar/excluir proxy de API
Proxy de API por revisão /applications/*/revisions GET Listar revisões do proxy de API
/applications/*/revisions/* GET, PUT, DELETE Acessar/atualizar/excluir revisão do proxy de API
Implantações de proxy de API /applications/*/deployments GET Listar todas as implantações de proxy de API
/applications/*/revisions/*/deployments GET, PUT Listar/cancelar a implantação de revisões do proxy de API
Implantações de proxy de API no nível do ambiente /environments/*/deployments GET Listar proxies de API implantados em um ambiente
/environments/*/applications/*/deployments GET Receber detalhes da implantação de um proxy de API em um ambiente
Implantações de proxy de API no nível do ambiente e da revisão /environments/*/applications/*/revisions/*/deployments GET, PUT, DELETE Acessar detalhes de implantação de uma revisão de proxy de API em um ambiente e implantar/cancelar a implantação de revisão de proxy de API
Dependências npm do proxy de API /applications/*/revisions/*/npm GET Recebe dependências npm para um proxy de API.
Políticas de proxy de API /applications/*/revisions/*/policies GET, PUT Listar/criar políticas em um proxy de API
/applications/*/revisions/*/policies/* GET Acessar política no escopo do proxy de API

Apps

Apps /apps GET Listar apps
/apps/* GET Buscar app por ID

Consulta assíncrona

Consultas /environments/*/queries GET, PUT Listar/criar consulta assíncrona
/environments/*/queries/* GET Receber status da consulta assíncrona
/environments/*/queries/*/result GET Receber resultados da consulta assíncrona

Auditorias

Auditorias /audits/organizations/* GET Listar entradas de auditoria de toda a organização
/audits/organizations/*/apiproducts GET Listar entradas de auditoria de todos os produtos de API em uma organização
/audits/organizations/*/apiproducts/* GET Listar entradas de auditoria do produto de API em uma organização
/audits/organizations/*/applications GET Listar entradas de auditoria de todos os aplicativos em uma organização
/audits/organizations/*/applications/* GET Listar entradas de auditoria de um aplicativo em uma organização
/audits/organizations/*/developers GET Listar entradas de auditoria de todos os desenvolvedores em uma organização
/audits/organizations/*/developers/* GET Listar entradas de auditoria de um desenvolvedor em uma organização
/audits/organizations/*/developers/*/apps GET Listar entradas de auditoria de todos os apps de desenvolvedor em uma organização
/audits/organizations/*/developers/*/apps/* GET Listar entradas de auditoria de um app de desenvolvedor em uma organização
/audits/users/* GET Listar entradas de auditoria de todos os usuários em uma organização

Caches

Registros em cache /environments/*/applications/*/cachedlogs/categories GET Acessar categorias de registro armazenadas em cache
/environments/*/applications/*/cachedlogs/categories/nodejs GET Acessar registros do Node.js em cache
Caches /environments/*/caches GET, PUT Listar/criar caches
/environments/*/caches/* GET, PUT, DELETE Receber/atualizar/excluir cache
/environments/*/caches/*/entries PUT Limpar todas as entradas de cache
/environments/*/caches/*/entries/* PUT Limpar entradas de cache

Empresas (monetização)

Empresas (monetização) /companies GET, PUT Listar/criar empresa
/companies/* GET, PUT, DELETE Acessar/atualizar/excluir empresa
Famílias de apps da empresa (monetização) /companies/*/appfamilies GET, PUT Listar/criar famílias de apps da empresa
/companies/*/appfamilies/* GET, PUT, DELETE Acessar/atualizar/excluir a família de apps da empresa
/companies/*/appfamilies/*/apps/* EXCLUIR Remover app da empresa da família
Apps da empresa (monetização) /companies/*/apps GET, PUT Listar/criar apps da empresa
/companies/*/apps/* GET, PUT, DELETE Acessar/atualizar/excluir o app da empresa
Chaves de app da empresa (monetização) /companies/*/apps/*/keys/* GET Receber a chave de app da empresa por ID
Desenvolvedores de apps da empresa (monetização) /companies/*/developers GET, PUT Listar/criar desenvolvedores de apps da empresa
/companies/*/developers/* GET, PUT, DELETE Acessar/atualizar/excluir o desenvolvedor de apps da empresa

Créditos (monetização)

Créditos (monetização) /monetization-packages/*/rate-plans/*/real-currency-credit-transactions PUT Emitir crédito para um desenvolvedor
/transaction-search PUT Listar créditos emitidos

Relatórios personalizados

Relatórios personalizados /reports GET, PUT Listar/criar relatórios de análise personalizados
/reports/* GET, PUT, DELETE Acessar/atualizar/excluir relatório de análise personalizado
/environments/*/analytics/admin/* GET Acessar métricas e dimensões usadas para criar relatórios de análise

Máscaras de dados

Máscaras de dados no escopo da organização /maskconfigs GET, PUT Listar/criar máscaras de dados no escopo da organização
/maskconfigs/* GET, PUT, DELETE Receber/atualizar/excluir máscara de dados no escopo da organização
Máscaras de dados no escopo do proxy de API /apiproxies/*/maskconfigs GET, PUT Listar/criar máscaras de dados no escopo do proxy de API
/apiproxies/*/maskconfigs/* GET, PUT, DELETE Receber/atualizar/excluir máscara de dados no escopo do proxy de API
/applications/*/maskconfigs GET, PUT Listar/criar máscaras de dados no escopo do proxy de API
/applications/*/maskconfigs/* GET, PUT, DELETE Receber/atualizar/excluir máscara de dados no escopo do proxy de API

Depuração

Depuração /environments/*/applications/*/revisions/*/debugsessions GET, PUT Listar/criar sessões de depuração
/environments/*/applications/*/revisions/*/debugsessions/* GET, PUT, DELETE Acessar/atualizar/excluir sessões de depuração
/environments/*/applications/*/revisions/*/debugsessions/*/data GET Listar IDs de transação da sessão de depuração
/environments/*/applications/*/revisions/*/debugsessions/*/data/* GET Receber dados de transação da sessão de depuração pelo ID

Deployments

Implantações no nível da organização /deployments GET Listar todas as APIs implantadas em uma organização

Desenvolvedores

Desenvolvedores /developers GET, PUT Listar/criar desenvolvedores de apps
/developers/* GET, PUT, DELETE Acessar/atualizar/excluir desenvolvedor de apps
Atributos do app do desenvolvedor /developers/*/apps/*/attributes GET, PUT Listar/atualizar todos os atributos do app do desenvolvedor
/developers/*/apps/*/attributes/* GET, PUT, DELETE Acessar/atualizar/excluir atributo de app do desenvolvedor
Famílias de apps do desenvolvedor /developers/*/appfamilies GET, PUT Listar/criar famílias de apps do desenvolvedor
/developers/*/appfamilies/* GET, PUT, DELETE Acessar/atualizar/excluir a família de apps do desenvolvedor
/developers/*/appfamilies/*/apps/* EXCLUIR Remover app do desenvolvedor da família
Chaves do app do desenvolvedor /developers/*/apps/*/keys/* GET, PUT, DELETE Listar/atualizar/excluir a chave de app do desenvolvedor
/developers/*/apps/*/keys/create PUT Criar uma chave e um secret do cliente para um app
/developers/*/apps/*/keys/*/apiproducts/* PUT, DELETE Aprovar/revogar uma chave do cliente para um app
/developers/*/apps/*/keys/*/oauth1accesstokens GET Receber tokens de acesso do OAuth 1.0 para a chave de app de um desenvolvedor.
/developers/*/apps/*/keys/*/oauth2accesstokens GET Receber tokens de acesso do OAuth 2.0 para a chave de app de um desenvolvedor.
/developers/*/apps/*/oauth1accesstokens GET Receber tokens de acesso do OAuth 1.0 para o app de um desenvolvedor.
/developers/*/apps/*/oauth2accesstokens GET Mostra os tokens de acesso do OAuth 2.0 do app de um desenvolvedor.
Apps para desenvolvedores /developers/*/apps GET, PUT Listar/criar apps de desenvolvedor
/developers/*/apps/* GET, PUT, DELETE Instalar/atualizar/excluir app do desenvolvedor
Atributos do desenvolvedor /developers/*/attributes GET, PUT Listar/atualizar todos os atributos do desenvolvedor
/developers/*/attributes/* GET, PUT, DELETE Acessar/atualizar/excluir atributo do desenvolvedor

Keystores

Keystores /environments/*/keystores GET, PUT Listar/criar keystores
/environments/*/keystores/* GET, PUT, DELETE Acessar/atualizar/excluir keystore
/environments/*/keystores/*/aliases GET, PUT Listar/criar aliases de keystore
/environments/*/keystores/*/aliases/* GET, PUT, DELETE Acessar/atualizar/excluir alias do keystore
/environments/*/keystores/*/aliases/*/certificate GET Exportar um certificado para um alias
/environments/*/keystores/*/aliases/*/csr GET Gerar uma CSR para um alias
/environments/*/keystores/*/certs GET, PUT Listar/fazer upload do certificado do keystore
/environments/*/keystores/*/certs/* GET, PUT, DELETE Acessar/atualizar/excluir o certificado do keystore
/environments/*/keystores/*/certs/*/export GET Exportar um certificado de um keystore
/environments/*/keystores/*/keys PUT Fazer upload de um arquivo JAR para um keystore
/environments/*/testssl GET, PUT Testar um keystore ou um truststore

Mapas de chave-valor (KVMs)

Mapas de chave-valor (KVMs) no escopo da organização /keyvaluemaps GET, PUT Listar/criar KVMs no escopo da organização
/keyvaluemaps/* GET, PUT, DELETE Receber/atualizar/excluir a KVM no escopo da organização
/keyvaluemaps/*/entries PUT Criar entradas KVM no escopo da organização
/keyvaluemaps/*/entries/* GET, PUT, DELETE Receber/atualizar/excluir entrada da KVM no escopo da organização
/keyvaluemaps/*/keys GET Listar chaves em uma KVM no escopo da organização
Mapas de chave-valor (KVMs) no escopo do ambiente /environments/*/keyvaluemaps GET, PUT Listar/criar KVMs no escopo do ambiente
/environments/*/keyvaluemaps/* GET, PUT, DELETE Receber/atualizar/excluir KVM no escopo do ambiente
/environments/*/keyvaluemaps/*/entries PUT Criar entradas KVM no escopo do ambiente
/environments/*/keyvaluemaps/*/entries/* GET, PUT, DELETE Receber/atualizar/excluir entrada da KVM no escopo do ambiente
/environments/*/keyvaluemaps/*/keys GET Listar chaves em uma KVM no escopo do ambiente
Mapas de chave-valor (KVMs) no escopo do proxy de API /applications/*/keyvaluemaps GET, PUT Listar/criar KVMs no escopo do proxy de API
/applications/*/keyvaluemaps/* GET, PUT, DELETE Receber/atualizar/excluir a KVM no escopo do proxy da API
/applications/*/keyvaluemaps/*/entries GET, PUT Listar/criar entradas KVM no escopo do proxy da API
/applications/*/keyvaluemaps/*/entries/* GET, PUT, DELETE Receber/atualizar/excluir entrada da KVM no escopo do proxy da API
/applications/*/keyvaluemaps/*/keys GET Acessar todas as entradas KVM no escopo do proxy da API

OAuth

OAuth 1.0 /oauth1/accesstokens GET Receber tokens de acesso do OAuth 1.0
/oauth1/accesstokens/* GET, PUT, DELETE Receber/atualizar/excluir/aprovar token de acesso OAuth 1.0
/oauth1/requesttokens GET Acessar a contagem de tokens de solicitação OAuth 1.0
/oauth1/requesttokens/* GET, PUT, DELETE Receber/atualizar/excluir/aprovar token de solicitação OAuth 1.0
/oauth1/verifiers GET Acessar a contagem de códigos do verificador OAuth 1.0
/oauth1/verifiers/* GET ou DELETE Receber/atualizar/excluir/aprovar o código do verificador OAuth 1.0
OAuth 2.0 /oauth2/accesstokens/* GET, PUT, DELETE Receber/atualizar/excluir/aprovar token de acesso do OAuth 2.0
/oauth2/authorizationcodes GET Ver o número de códigos de autorização do OAuth 2.0
/oauth2/authorizationcodes/* GET ou DELETE Receber/atualizar/excluir/aprovar códigos de autorização OAuth 2.0
/oauth2/refreshtokens/* PUT Aprovar ou revogar um token de atualização do OAuth 2.0
/oauth2/revoke PUT Revogar o token de acesso OAuth 2.0 por usuário ou ID do aplicativo
/oauth2/search GET Receber o token de acesso OAuth 2.0 por ID do usuário ou do app

Organizações

Organizações / GET, PUT Listar/criar recursos da organização
/* GET, PUT, DELETE Acessar/atualizar/excluir recursos da organização

Planos de tarifas (monetização)

Planos de tarifas (monetização) /monetization-packages/*/rate-plans GET, PUT Listar/criar planos de tarifas
/monetization-packages/*/rate-plans/* GET, PUT, DELETE Acessar/atualizar/excluir um plano de tarifa
/monetization-packages/*/rate-plans/*/revision PUT Criar uma revisão do plano de tarifas (ou um plano de tarifas futuro)

References

Referências /environments/*/references GET, PUT Listar/criar referência no escopo do ambiente
/environments/*/references/* GET, PUT, DELETE Referência de recebimento/atualização/exclusão no escopo do ambiente

Reembolsos (monetização)

Reembolsos (monetização) /monetization-packages/*/refund-transactions PUT Emitir um reembolso
/transaction-search PUT Listar reembolsos emitidos

Relatórios (monetização)

Relatórios (monetização) /report-definitions GET, PUT Listar/criar definições de relatórios
/report-definitions/* GET, PUT, DELETE Acessar/atualizar/excluir uma definição de relatório
/billing-reports

/revenue-reports

/prepaid-balance-reports

/variance-reports

PUT Gerar um relatório

Arquivos de recurso

Arquivos de recurso no escopo da organização /resourcefiles GET, PUT Listar/fazer upload de arquivos de recursos no escopo da organização
/resourcefiles/*/* GET, PUT, DELETE Acessar/atualizar/excluir o arquivo de recurso no escopo da organização
Arquivos de recursos no escopo do ambiente /environments/*/resourcefiles GET, PUT Listar/importar arquivos de recursos no escopo do ambiente
/environments/*/resourcefiles/*/* GET, PUT, DELETE Acessar/atualizar/excluir o arquivo de recurso no escopo do ambiente
Arquivos de recursos no escopo do proxy de API /applications/*/revisions/*/resourcefiles GET, PUT Liste/importe arquivos de recursos no escopo do proxy de API
/applications/*/revisions/*/resourcefiles/*/* GET, PUT, DELETE Acessar/atualizar/excluir o arquivo de recurso no escopo do proxy de API

Papéis

Papéis /userroles GET, PUT Listar/criar funções de usuário
/userroles/* GET, PUT, DELETE Acessar/atualizar/excluir a função do usuário
/userroles/*/permissions GET, PUT Listar/adicionar permissões para um papel
/userroles/*/permissions/* GET, PUT, DELETE Receber/atualizar/excluir permissão para um papel
/userroles/*/resourcepermissions PUT Adicionar várias permissões a um recurso
/userroles/*/users GET, PUT Listar/adicionar usuários à função
/userroles/*/users/* GET ou DELETE Verificar usuário na função, remover usuário da função

Fluxos compartilhados

Fluxos compartilhados /sharedflows GET, PUT Listar/criar fluxos compartilhados.
/sharedflows/* GET, PUT, DELETE Confira/exclua o fluxo compartilhado.
/sharedflows/*/deployments GET Conferir implantações de fluxo compartilhado.
/sharedflows/*/revisions GET Conferir revisões de fluxo compartilhado.
/sharedflows/*/revisions/* GET, PUT, DELETE Consultar, modificar e excluir revisões de fluxo compartilhado.
/sharedflows/*/revisions/*/deployments GET ou DELETE Conferir/excluir a implantação de revisões de fluxo compartilhado.
/environments/*/sharedflows/*/revisions/*/deployments PUT, DELETE Implantar e cancelar revisões de fluxo compartilhado.
/environments/*/flowhooks/* GET, PUT, DELETE Fluxos compartilhados em ganchos de fluxo: anexar, remover e receber.

Estatísticas (em inglês)

Estatísticas /stats/ GET Conseguir métricas por intervalo de tempo para uma organização e um ambiente.
/environments/*/stats/* GET Organizar as métricas por dimensões
/stats/preferences/reports/dailysummaryreport GET Inscrever-se ou cancelar a inscrição no relatório de análise
/stats/preferences/reports/dailysummaryreport/users GET Receber uma lista de usuários inscritos e não inscritos

Servidores de destino

Servidores de destino /environments/*/targetservers GET, PUT Listar/criar servidores de destino
/environments/*/targetservers/* GET, PUT, DELETE Acessar/atualizar/excluir servidor de destino

Usuários

Usuários /users GET, PUT Listar/adicionar usuários
/users/* GET, PUT, DELETE Acessar/atualizar/excluir usuário

Transações (monetização)

Transações (monetização) /transactions/developers/* GET Conferir o status das transações

Hosts virtuais

Hosts virtuais /environments/*/virtualhosts GET, PUT Listar/criar hosts virtuais (apenas para organizações de nuvem privada e paga)
/environments/*/virtualhosts/* GET, PUT, DELETE Receber/atualizar/excluir hosts virtuais (atualizar/excluir apenas para organizações de nuvem privada e de nuvem paga)
/environments/*/virtualhosts/*/sslinfo PUT Atualizar a configuração de TLS para um host virtual (somente organizações de nuvem privada e de nuvem paga)