Associate Group

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/group
API call form
Examples

Division or group within or across the bounds of organizations. Groups have administrators and members and can be assigned access rights to datasets or dashboards. The creating user of a group is automatically given group owner rights. Groups can be created by any user. Only group owners can update or delete a group, or associate or dissociate new group members.

Groups can be associated to users ( Users ), to dashboards and datasets ( Securables ), to collections ( Collections ), to dashboard favorites ( Favorites ), and to connections ( Shareables , using the shareable_id of a connection/account).

Request parametersResponse schema
id UUID

The unique identifier of the entity

name Multilingual string

Internationalized description of the group.

suborganization STRING

The name of the suborganization group.

created_at DATETIME

RFC 3339 date time string indicating when the resource was created

updated_at DATETIME

RFC 3339 date time string indicating when the resource was last updated

public BOOLEAN

Flag for signifying whether the group is public

Can be executed by:
Entity Owner
&
Securable Owner
(For: Dashboard)
Entity Owner
&
Securable Owner
(For: Dataset)
Entity Owner
&
Logged-in User
(For: User)
Can be associated to:
Dashboard
Dataset
User
Organization
Collection
Shareable
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
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: 'Users', id: '< user id >' },
  {
    flagMember: true,
    flagOwn: false
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "code": 200
}