Saltar al contenido principal

API de Politicas

Las politicas definen que acciones los usuarios pueden o no realizar sobre los recursos. Console usa un sistema de politicas estilo IAM con strings de accion service:action.

Objeto Politica​

CampoTipoDescripcion
_idstringIdentificador unico
arnstringARN de la politica (arn:s42:iam::{company_id}:policy/{type}/{name})
namestringNombre de la politica
descriptionstringDescripcion legible
typestringsystem, managed o inline
documentobjectDocumento de politica con statements
is_deprecatedbooleanSi la politica esta deprecada
created_atstringTimestamp ISO 8601 de creacion
updated_atstringTimestamp ISO 8601 de ultima actualizacion

Documento de Politica​

{
  "version": "2025-01-01",
  "statements": [
    {
      "sid": "AllowReadUsers",
      "effect": "Allow",
      "actions": ["users:list", "users:get"],
      "resources": ["*"]
    }
  ]
}

Campos del Statement​

CampoTipoObligatorioDescripcion
sidstringNoIdentificador del statement
effectstringSiAllow o Deny
actionsstring[]SiPatrones de accion (ej.: users:list, users:*, *)
resourcesstring[]SiPatrones de ARN de recurso o *

Listar Politicas​

Devuelve todas las politicas visibles para el usuario actual (politicas managed + politicas custom de la company).

GET/v1/policies

Permiso requerido: policies:list

Ejemplo de Request:

curl https://api.console.solucao42.com.br/v1/policies \
  -H "Authorization: Bearer YOUR_TOKEN"

Respuesta: 200 OK

{
  "total": 3,
  "quantity": 3,
  "records": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "arn": "arn:s42:iam::policy/managed/ReadOnly",
      "name": "ReadOnly",
      "description": "Acceso solo lectura a todos los recursos",
      "type": "managed",
      "document": {
        "version": "2025-01-01",
        "statements": [
          {
            "sid": "ReadAll",
            "effect": "Allow",
            "actions": ["users:list", "users:get", "connections:list"],
            "resources": ["*"]
          }
        ]
      },
      "is_deprecated": false,
      "created_at": "2025-01-01T00:00:00.000Z",
      "updated_at": "2025-01-01T00:00:00.000Z"
    }
  ]
}

Obtener Politica​

Devuelve una politica por ID.

GET/v1/policies/:id

Permiso requerido: policies:get

Listar Acciones Disponibles​

Devuelve todas las strings service:action disponibles para usar en documentos de politica.

GET/v1/policies/actions

Autenticacion: Requerida (sin permiso especifico)

Ejemplo de Respuesta:

{
  "services": {
    "users": ["users:list", "users:get", "users:invite", "users:update", ...],
    "connections": ["connections:list", "connections:get", "connections:create", ...],
    "visualizations": ["visualizations:list", "visualizations:get", "visualizations:execute", ...]
  },
  "all": ["users:list", "users:get", ..., "data_api:execute", "data_api:get_job"]
}

Crear Politica​

Crea una nueva politica custom para la company.

POST/v1/policies

Permiso requerido: policies:create

Request Body:

CampoTipoObligatorioDescripcion
namestringSiNombre de la politica (unico dentro de la company)
descriptionstringNoDescripcion legible
documentobjectSiDocumento de politica con statements

Ejemplo de Request:

curl -X POST https://api.console.solucao42.com.br/v1/policies \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dashboard Viewer",
    "description": "Puede ver y ejecutar dashboards",
    "document": {
      "version": "2025-01-01",
      "statements": [
        {
          "sid": "ViewDashboards",
          "effect": "Allow",
          "actions": [
            "dashboards:list",
            "dashboards:get",
            "visualizations:list",
            "visualizations:get",
            "visualizations:execute",
            "analysis-folders:list",
            "analysis-folders:get"
          ],
          "resources": ["*"]
        }
      ]
    }
  }'

Respuesta: 201 Created

Actualizar Politica​

Actualiza una politica custom existente.

PUT/v1/policies/:id

Permiso requerido: policies:update

precaución

Las politicas system y managed (type: system o type: managed) no pueden modificarse via API.

Eliminar Politica​

Elimina una politica custom.

DELETE/v1/policies/:id

Permiso requerido: policies:delete

Respuesta: 204 No Content

Clonar Politica​

Crea una copia de una politica existente (incluyendo politicas managed) como nueva politica custom.

POST/v1/policies/:id/clone

Permiso requerido: policies:create

Politicas Managed Predefinidas​

Estas politicas estan disponibles en cada company y pueden asignarse a grupos pero no modificarse.

PoliticaAcciones Clave
FullAdmin*
ReadOnly*:list, *:get, acciones de solo lectura en todos los servicios
UserManagerusers:list/get/invite/update/activate/deactivate/assign_groups/remove_groups
GroupManagergroups:*, policies:list/get
ApiKeyManagerusers:list_integration_users/create_integration_user/delete_integration_user, api_keys:*
ConnectionManagerconnections:*, vpn_profiles:*, managed-tables:*, metadata:read
VisualizationViewerdashboards:list/get/schedule, visualizations:list/get/execute/schedule, data_api:execute/get_job
VisualizationManagervisualizations:*, dashboards:share/schedule, analysis-folders:*, data_api:execute/get_job
AnalyticsAuthorvisualizations:*, dashboards:*, analysis-folders:*, share_tags:*, viz_api_endpoints:*, data_api:execute/get_job
KnowledgeManagerconcepts:*, semantic:*, ontology:*, knowledge_reviews:*, metadata:read
DataEngineerconnections:*, vpn_profiles:*, managed-tables:*, metadata:read
PolicyManagerpolicies:*
CompanyAdmincompany:*
DataAPIConsumerdata_api:execute/get_job

Ejemplos de Codigo​

const API_URL = 'https://api.console.solucao42.com.br';

// Listar todas las politicas disponibles
async function listPolicies(token) {
  const response = await fetch(`${API_URL}/v1/policies`, {
    headers: { 'Authorization': `Bearer ${token}` },
  });
  return response.json();
}

// Crear una politica custom
async function createPolicy(token, policy) {
  const response = await fetch(`${API_URL}/v1/policies`, {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(policy),
  });
  return response.json();
}

// Uso
const dashboardViewerPolicy = await createPolicy(token, {
  name: 'Dashboard Viewer',
  description: 'Solo ver y ejecutar dashboards',
  document: {
    version: '2025-01-01',
    statements: [
      {
        sid: 'ViewDashboards',
        effect: 'Allow',
        actions: [
          'dashboards:list',
          'dashboards:get',
          'visualizations:list',
          'visualizations:get',
          'visualizations:execute',
        ],
        resources: ['*'],
      },
    ],
  },
});

console.log(`Politica creada: ${dashboardViewerPolicy._id}`);

Buenas Practicas​

  1. Empezar desde politicas managed — clona una managed y ajusta en lugar de construir desde cero
  2. Usar Deny con moderacion — Deny sobreescribe cualquier Allow; usalo solo para excepciones explicitas
  3. Privilegio minimo — concede solo las acciones que el usuario realmente necesita
  4. Nombres descriptivos — Analytics Team Viewer es mejor que Policy 1
  5. Probar antes de asignar — verifica que la politica hace lo esperado usando el endpoint /v1/auth/permissions
Última actualización en