Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

El nombre de un rol personalizado, para qué sirve y los permisos que tiene, para crearlo o cambiarlo.

name
string
requerido

El nombre del rol. Ningún otro rol de la organización puede tenerlo.

Maximum string length: 100
permissions
string[]
requerido

Los nombres de los permisos que tiene el rol, como inventory.stock.view, de la lista de permisos que puede tener un rol personalizado. Envía una lista vacía para un rol sin ninguno.

description
string | null

Para qué sirve el rol, que se muestra junto con él en la lista de roles.

Maximum string length: 500

Respuesta

RoleResource

data
RoleResource · object
requerido

Un rol definido en la organización.