kobana billing team-roles
Comandos de kobana billing team-roles. Toda opción global (Opciones globales) vale aquí.
| Comando | HTTP | Descripción |
|---|---|---|
team-roles list | GET /v1/team_roles | Listar roles del equipo |
team-roles create | POST /v1/team_roles | Crear rol personalizado |
team-roles update | PUT /v1/team_roles | Crea o actualiza un rol de equipo |
team-roles get | GET /v1/team_roles/{id} | Obtener rol |
team-roles delete | DELETE /v1/team_roles/{id} | Eliminar rol |
team-roles list
Listar roles del equipo
kobana billing team-roles list [OPCIONES]
GET /v1/team_roles
Devuelve la lista paginada de roles configurados para el equipo de la organización. Incluye tanto roles de sistema (is_system = true) como roles personalizados.
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
page | integer | no | Página (comienza en 1). Por defecto: 1. |
per_page | integer | no | Ítems por página. Por defecto: 20. Máximo: 100. |
sort_by | string | no | Campo de ordenación. El valor por defecto depende del recurso. |
sort_order | string | no | Dirección de ordenación. Por defecto: desc. Valores: asc, desc. |
search | string | no | Búsqueda textual por nombre o slug. |
is_active | boolean,null | no | Filtra por roles activos (true) o inactivos (false). |
is_system | boolean,null | no | Filtra por roles de sistema (true) o personalizados (false). |
Respuestas
| HTTP | Descripción |
|---|---|
200 | Lista paginada de roles. |
404 | Recurso no encontrado en la organización actual. |
team-roles create
Crear rol personalizado
kobana billing team-roles create [OPCIONES]
POST /v1/team_roles
Crea un rol personalizado. El slug debe empezar con una letra minúscula y contener solo letras minúsculas, dígitos y _.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name | string | sí | Nombre del rol (mostrado en la interfaz). |
slug | string | sí | Slug estable usado para referenciar el rol (ej.: billing_manager). |
permissions | array<string> | sí | Lista de slugs de permisos concedidos por el rol. |
description | string | no | Descripción opcional de lo que concede el rol. |
is_active | boolean | no | Indica si el rol está activo y puede ser asignado. |
external_id | string | no | Identificador en su sistema externo, para idempotencia/sincronización. |
custom_metadata | object | no | Metadatos arbitrarios definidos por el cliente (clave/valor). |
Otros campos y objetos anidados: kobana schema billing.team-roles.create.
Respuestas
| HTTP | Descripción |
|---|---|
201 | Rol creado. |
400 | El cuerpo de la solicitud falló en la validación. |
404 | Recurso no encontrado en la organización actual. |
422 | El cuerpo de la solicitud falló en la validación. |
team-roles update
Crea o actualiza un rol de equipo
kobana billing team-roles update [OPCIONES]
PUT /v1/team_roles
Localiza el rol por id, public_id o external_id. El slug no tiene restricción de unicidad y por lo tanto no identifica un registro. Si lo encuentra, lo actualiza; si no, lo crea y devuelve 201.
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name | string | no | Nombre del rol (mostrado en la interfaz). |
slug | string | no | Slug estable usado para referenciar el rol (ej.: billing_manager). |
description | string | no | Descripción opcional de lo que concede el rol. |
permissions | array<string> | no | Lista de slugs de permisos concedidos por el rol. |
is_active | boolean | no | Indica si el rol está activo y puede ser asignado. |
external_id | string | no | Identificador en su sistema externo, para idempotencia/sincronización. |
custom_metadata | object | no | Metadatos arbitrarios definidos por el cliente (clave/valor). |
id | string (uuid) | no | UUID del registro. Se usa solo para localizarlo — nunca se guarda. |
public_id | string (uuid) | no | UUID público del registro, usado para localizarlo. |
Otros campos y objetos anidados: kobana schema billing.team-roles.update.
Respuestas
| HTTP | Descripción |
|---|---|
200 | Registro actualizado. |
201 | Registro creado. |
400 | El cuerpo de la solicitud falló en la validación. |
404 | Recurso no encontrado en la organización actual. |
422 | El cuerpo de la solicitud falló en la validación. |
team-roles get
Obtener rol
kobana billing team-roles get [ID] [OPCIONES]
GET /v1/team_roles/{id}
Argumentos de la ruta: id
Respuestas
| HTTP | Descripción |
|---|---|
200 | Detalle del rol. |
404 | Recurso no encontrado en la organización actual. |
team-roles delete
Eliminar rol
kobana billing team-roles delete [ID] [OPCIONES]
DELETE /v1/team_roles/{id}
Realiza soft delete del rol. Los roles de sistema (is_system = true) no pueden eliminarse.
Argumentos de la ruta: id
Respuestas
| HTTP | Descripción |
|---|---|
200 | Rol eliminado. |
404 | Recurso no encontrado en la organización actual. |