Âmbitos (Scopes)
Um token só acede ao que os seus âmbitos permitem. Gerado diretamente do registo de âmbitos — nunca escrito à mão em duplicado.
Ativos
| Estudantes — Leitura Listar e consultar estudantes via a API REST. | students:read |
| Cursos — Leitura Listar e consultar cursos e as suas turmas (sessões de formação) via a API REST. | courses:read |
| Matrículas — Leitura Listar e consultar matrículas via a API REST. | enrolments:read |
| Certificados — Leitura Listar e consultar certificados emitidos via a API REST. A verificação pública continua a não usar tokens. | certificates:read |
| Utilizadores — Leitura Listar e consultar utilizadores administrativos via a API REST. | users:read |
| Utilizadores — Escrita Criar e editar utilizadores administrativos, e executar ações de ciclo de vida (convidar, suspender, reativar, arquivar) via a API REST. | users:write |
| Notificações de Identidade — Leitura Listar e consultar o registo de notificações de ciclo de vida de identidade via a API REST. | identity-notifications:read |
| Organização — Leitura Consultar as definições da organização via a API REST. | organization:read |
| Organização — Escrita Atualizar as definições da organização via a API REST. | organization:write |
| Pesquisa — Leitura Pesquisar globalmente na plataforma via a API REST. | search:read |
| Relatórios — Leitura Listar e consultar relatórios gerados via a API REST. | reports:read |
| Relatórios — Escrita Pedir a geração de novos relatórios via a API REST. | reports:write |
| Documentos — Leitura Listar e consultar documentos via a API REST. | documents:read |
| Documentos — Escrita Carregar, editar metadados, arquivar e eliminar documentos via a API REST. | documents:write |
| Workflows — Leitura Listar e consultar instâncias de workflow via a API REST. | workflows:read |
| Workflows — Escrita Atribuir e transitar instâncias de workflow via a API REST. | workflows:write |
| Tarefas Agendadas — Leitura Listar e consultar tarefas agendadas via a API REST. | tasks:read |
| Tarefas Agendadas — Escrita Executar manualmente uma tarefa agendada via a API REST. | tasks:write |
| Mensagens de Integração — Leitura Listar e consultar mensagens de integração via a API REST. | integration-messages:read |
| Mensagens de Integração — Escrita Reenviar (retry) uma mensagem de integração falhada via a API REST. | integration-messages:write |
| Saúde da Plataforma — Leitura Consultar o estado das verificações de saúde da plataforma via a API REST. | health:read |
Reservados — sem efeito em nenhum endpoint ainda
| Estudantes — Escrita Reservado — não existe ainda nenhum endpoint de escrita para estudantes. | students:write |
| Cursos — Escrita Reservado — não existe ainda nenhum endpoint de escrita para cursos. | courses:write |
| Matrículas — Escrita Reservado — não existe ainda nenhum endpoint de escrita para matrículas. | enrolments:write |
| Candidaturas — Leitura Reservado — candidaturas não são expostas pela API REST. | applications:read |
| Candidaturas — Escrita Reservado — candidaturas não são expostas pela API REST. | applications:write |
| Presenças — Leitura Reservado — presenças não são expostas pela API REST. | attendance:read |
| Presenças — Escrita Reservado — presenças não são expostas pela API REST. | attendance:write |
| Certificados — Emissão Reservado — a emissão de certificados só existe no painel administrativo. | certificates:issue |
| Certidões — Leitura Reservado — certidões não são expostas pela API REST. | transcripts:read |
| Webhooks — Gestão Reservado — a gestão de webhooks só existe no painel administrativo (sessão web), não pela API REST. | webhooks:manage |
| Notificações — Gestão Reservado — a gestão de canais de notificação só existe no painel administrativo (sessão web), não pela API REST. | notifications:manage |
| Integrações — Gestão Reservado — a Consola de Integração só existe no painel administrativo (sessão web), não pela API REST. | integrations:manage |