Aller à la documentation
API

Lister les permissions

Tout le vocabulaire, avec la phrase et le titre sous lesquels chaque entrée s'affiche.

GETapi.openemail.uk/roles/permissions

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

GET /roles/permissions

Tout le vocabulaire, avec la phrase et le titre sous lesquels chaque entrée s'affiche.

Exemple

Requiert roles:read. Une constante : la même réponse pour chaque espace de travail, et la liste à partir de laquelle construire une matrice plutôt que de la recopier dans votre propre code.

curl
curl "$OE/roles/permissions" -H "$AUTH"
Réponse
{  "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    }  ]}

Enregistré AVANT /roles/{id}, faute de quoi permissions est lu comme un id de rôle et chaque requête renvoie un 404. /rules/runs porte la même note, et /tracking/stats avant elle, toutes deux écrites après le même bug. Demander un rôle réellement appelé « permissions » demande donc un rôle et obtient un 404, ce qui est la réponse honnête à ce qui a été saisi.

scope indique si une CLÉ API peut détenir la permission. Cinq ne le peuvent pas (api-keys:read, api-keys:write, billing:read, billing:write et workspace:manage), parce qu'aucun endpoint ne leur correspond et qu'une clé n'est pas une personne. C'est ce drapeau qui permet à un seul composant de rendre à la fois la matrice des rôles et la liste de cases à cocher de création de clé, au lieu d'une seconde copie maintenue à la main de ce qui relève de l'un ou de l'autre.

Servie plutôt que recopiée, pour la raison qu'indique la liste des champs de règles : une matrice construite à partir d'un tableau copié continue de proposer une permission le jour où l'une est renommée et ne propose jamais celle ajoutée la semaine dernière. group est le titre sous lequel elle s'affiche et retombe sur other plutôt que de partir undefined. Une permission que personne ne voit est une permission que personne n'audite.

L'ordre est canonique : c'est celui dans lequel revient le tableau permissions d'un rôle stocké, si bien qu'un client qui rend cette liste et un client qui rend un rôle affichent les mêmes permissions dans le même ordre.

Pas d'enveloppe au-delà d'object et data. Le vocabulaire est clos et court : il n'y a donc ni curseur ni hasMore, contrairement à toutes les autres listes de l'API.