Associate Organization

LLM-friendly URL

POST

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

API call form

Examples

Each user belongs to precisely 1 organization (company or association). Billing plans and invoices are managed on the organization-level. Several things are restricted within an organization. For example a user can't list users from another organization and dashboards/datasets are by default not accessible to other users. However, in case it is necessary to share securables cross organization, securables can be associated directly to a user or group.

Organizations their main connections are users and plugins. Besides of that you can also associate a default locale and a country to an organization and a thumbnail (logo of the organization) can be set.

Associating an organization with a country simply gives us the information we need about your company. The association between country and organization serves as a default for the users of your organization which can be overridden by associating a country to a user directly.

By associating a locale with your organization you set that locale as the default for the users in your organization. When a user has an association to a locale as well it will overrule the one from the organization. When you view a dashboard, the locale of the organization and/or user is taken into account to set the language.

By default, when you make a plugin via the API, the plugin is only associated to the user that created it. By associating the plugin to the organization you make it available to all users in the organization. Associating a plugin to an organization can be done by each organization member.

It is possible to associate your organization to a thumbnail to change the Logo.

The link between Organizations and Users is a special case: you can't add users to an organization once the users are made. If you use an owner's API token to create a user, the association between the organization and user will be made implicitly (i.e. the only way to add users to an organization is on creation time). If no API token is provided, the user will be added to a new organization.

To change the role of an existing user in your main organization, you need to use the API key-token pair from an organization owner, and set the desired flag(s) to true on the user-organization association.

Parameters

Expand all

Reset

Can be executed by:

Entity Owner

Logged-in User

(For: Country)

Entity Owner

Logged-in User

(For: Locale)

Entity Owner

Plugin Owner

(For: Plugin)

Entity Owner

Logged-in User

(For: Thumbnail)

Entity Owner

Logged-in User

(For: User)

Can be associated to:

Country

Locale

Plugin

Thumbnail

User

Did this page help you?

Yes

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('organization',
  '<your entity id>',
  { role: '<the resource>', id: '<the resource id>' }
);

Example Response

200

400

500

{
  "code": 200
}