Search Account

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/account

API call form

Examples

List of examples

Get Connection by ID
Get Connections for provider
Get Connection and it's dataset
Get Connection and who it is shared with

Description

Get a connection together with the users and groups that have access to it.

Access rights of a connection are not stored on the connection itself, but on a separate Shareable resource that every connection points to via its shareable_id . Include the Shareable model, and nest User and Group inside it, to see who a connection is shared with. The flagRead , flagUse , flagModify and flagOwn attributes describe the level of access each user or group has.

To actually share the connection, associate this shareable_id ( not the connection id ) to a user as shown here , or to a group as shown here .

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.get('account',
  {
    where: {
      id: "<your connection id>"
    },
    attributes: [
      "id",
      "name",
      "provider",
      "shareable_id"
    ],
    include: [
      {
        model: "Shareable",
        attributes: [
          "id"
        ],
        include: [
          {
            model: "User",
            attributes: [
              "id",
              "name",
              "flagRead",
              "flagUse",
              "flagModify",
              "flagOwn"
            ]
          },
          {
            model: "Group",
            attributes: [
              "id",
              "name",
              "flagRead",
              "flagUse",
              "flagModify",
              "flagOwn"
            ]
          }
        ]
      }
    ]
  }
);