Associate Group

LLM-friendly URL

POST

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

API call form

Examples

List of examples

Associate user to group
Associate dataset/dashboard to group
Share a connection with a group
Set dashboard variant as favorite for group

Description

Share a connection (account) with a group, so its members can use it to create datasets.

Access rights of a connection live on a separate Shareable resource, so you associate the connection's shareable_id ( not its id ) using the Shareables role. You can retrieve the shareable_id as shown here .

The flags are cumulative, and determine the access level:

flagRead + flagUse : group members can use the connection to create datasets.
additionally flagModify : group members can also edit the connection's credentials.
additionally flagOwn : group members can also delete the connection and manage who it is shared with.

Note that you need to be an owner of the connection to share it, that connections cannot be shared with a public group, and that connections for google , mailchimp , salesforce , teamleader and zendesk cannot be shared at all.

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.associate('group',
  '< group id >',
  { role: 'Shareables', id: '< shareable_id of the connection >' },
  {
    flagRead: true,
    flagUse: true
  }
);