Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

Le nom d'un rôle personnalisé, son objet et les autorisations qu'il comporte, pour le créer ou le modifier.

name
string
requis

Le nom du rôle. Aucun autre rôle de l'organisation ne peut l'avoir.

Maximum string length: 100
permissions
string[]
requis

Les noms des autorisations que le rôle détient, comme inventory.stock.view, tirés de la liste des autorisations qu'un rôle personnalisé peut détenir. Envoyez une liste vide pour un rôle sans autorisation.

description
string | null

À quoi sert le rôle, affiché avec lui dans la liste des rôles.

Maximum string length: 500

Réponse

RoleResource

data
RoleResource · object
requis

Un rôle défini dans l'organisation.