Saltar para a documentação
API

Listar permissões

O vocabulário inteiro, com a frase e o cabeçalho sob o qual cada entrada é apresentada.

GETapi.openemail.uk/roles/permissions

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /roles/permissions

O vocabulário inteiro, com a frase e o cabeçalho sob o qual cada entrada é apresentada.

Exemplo

Requer roles:read. Uma constante, a mesma resposta para todos os espaços de trabalho, e a lista a partir da qual construir uma matriz em vez de a transcrever para o seu próprio código.

curl
curl "$OE/roles/permissions" -H "$AUTH"
Resposta
{  "object": "list",  "data": [    {      "object": "permission",      "id": "emails:send",      "label": "Send email",      "group": "mail",      "scope": true    },    {      "object": "permission",      "id": "members:write",      "label": "Add and remove people, and change what they can reach",      "group": "people",      "scope": true    },    {      "object": "permission",      "id": "api-keys:write",      "label": "Create and revoke API keys",      "group": "developer",      "scope": false    },    {      "object": "permission",      "id": "workspace:manage",      "label": "Rename the workspace, remove domains and delete it",      "group": "workspace",      "scope": false    }  ]}

Registado ANTES de /roles/{id}, ou permissions é lido como um id de função e todos os pedidos a ele dão 404. /rules/runs tem a mesma nota por cima e /tracking/stats a seguir, ambas escritas depois do mesmo bug. Pedir uma função genuinamente chamada "permissions" pede, portanto, uma função e recebe um 404, que é a resposta honesta ao que foi escrito.

scope diz se uma CHAVE de API pode sequer ter a permissão. Cinco não podem (api-keys:read, api-keys:write, billing:read, billing:write e workspace:manage) porque não há endpoint para nenhuma delas e uma chave não é uma pessoa. É essa flag que permite a um único componente apresentar tanto a matriz de funções como a lista de caixas de seleção da criação de chaves, em vez de uma segunda cópia mantida à mão de quais são quais.

Servido em vez de transcrito, pela razão que a lista de campos das regras dá: uma matriz construída a partir de um array copiado continua a oferecer uma permissão no dia em que uma for renomeada e nunca oferece a que foi acrescentada na semana passada. group é o cabeçalho sob o qual é apresentada e cai para other em vez de sair indefinida. Uma permissão que ninguém vê é uma permissão que ninguém audita.

A ordem é canónica: é a ordem pela qual o array permissions de uma função guardada volta, portanto um cliente que apresente esta lista e um cliente que apresente uma função mostram as mesmas permissões na mesma sequência.

Sem envelope para além de object e data. O vocabulário é fechado e curto, portanto não há cursor nem hasMore, ao contrário de todas as outras listas da API.