Niucore

Referencia

Permisos

Roles, permisos y scopes efectivos. Lo que explica un 403.

Permisos efectivos

GETapi.niucore.com/api/v1/me/permissions

Scope: permissions:read

Los permisos vigentes del usuario y los scopes efectivos de la credencial, juntos. Es lo que explica un 403.

curl -sS -X GET 'https://api.niucore.com/api/v1/me/permissions' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": {
    "permissions": [
      "sidebar.chat",
      "workspaces.read.all",
      "skills.read.all"
    ],
    "scopes": [
      "chat:read",
      "chat:write",
      "libraries:read"
    ]
  },
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77"
  }
}

Listar permisos

GETapi.niucore.com/api/v1/permissions

Scope: permissions:read

Los permisos efectivos de la credencial, como colección paginada.

Nota

No devuelve el catálogo completo de la plataforma: publicarlo entero le contaría a cualquier credencial qué features existen y cómo se llaman.

Consulta

pageintegerpor defecto 1

Página, empezando en 1.

sizeintegerpor defecto 50

Elementos por página. Máximo 200.

curl -sS -X GET 'https://api.niucore.com/api/v1/permissions' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": [
    {
      "code": "sidebar.chat"
    },
    {
      "code": "workspaces.read.all"
    },
    {
      "code": "skills.read.all"
    }
  ],
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77",
    "page": 1,
    "size": 50,
    "total": 3
  }
}

Listar roles

GETapi.niucore.com/api/v1/roles

Scope: permissions:read

Roles definidos en la empresa.

Consulta

pageintegerpor defecto 1

Página, empezando en 1.

sizeintegerpor defecto 50

Elementos por página. Máximo 200.

curl -sS -X GET 'https://api.niucore.com/api/v1/roles' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": [
    {
      "id": 3,
      "name": "Administrador",
      "description": "Acceso total a la empresa."
    },
    {
      "id": 5,
      "name": "Supervisor",
      "description": "Gestiona su área."
    }
  ],
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77",
    "page": 1,
    "size": 50,
    "total": 2
  }
}

Ver un rol

GETapi.niucore.com/api/v1/roles/{role_id}

Scope: permissions:read

Detalle de un rol con sus permisos.

Ruta

role_idintegerobligatorio

Identificador del rol.

Errores

  • 404api_v1_not_foundEl rol no existe en la empresa.
curl -sS -X GET 'https://api.niucore.com/api/v1/roles/5' \
  -H "Authorization: Bearer $NIUCORE_ACCESS_TOKEN"
Respuesta
{
  "status": "success",
  "message": "Operación exitosa",
  "message_code": "api_v1_ok",
  "data": {
    "id": 5,
    "name": "Supervisor",
    "description": "Gestiona su área.",
    "permissions": [
      "sidebar.chat",
      "workspaces.read.area",
      "metrics.read.area"
    ]
  },
  "meta": {
    "request_id": "9f1c0a3e-7b2d-4f18-9a55-2c6e0d1b4a77"
  }
}