Associate Locale

LLM-friendly URL

POST

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

API call form

Examples

Locale's can be associated to Users, Organizations, Shares & Authorization tokens. If a dashboard is accessed via a share or token the locale of that token/share will be used. If no locale is assigned via the token or share, the locale of the user will be used. And finally, if the user has no locale, the default locale of the organization to which the user belongs is used.

Connecting a locale to an authorization is implicit. Instead of creating an association, we set the locale_id directly in the properties which will create an association for us. By connecting a locale you can determine in which locale the user will see a dashboard when the token is used for embedding, to get more information on how to embed a dashboard refer to the Integration API.

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.

A user is allowed to link a locale to a share in case the user is owner of the dashboard that is shared in the link. Associating a locale with the share will make sure that all users that open the dashboard via this link will see it in that specific locale. You can make multiple share links for a dashboard with different locales in case you need to send private links to a mixed audience.

Set the default language (locale) of the user. Datasets and dashboards will initially open with this selected language. The locale of the user needs to be changed by the entity owner. If you need to set the locale manually for each user you can use the login token when you created them to fetch an API token and set the locale for him.

Parameters

Expand all

Reset

Can be executed by:

Logged-in User

Authorization Owner

(For: Authorization)

Logged-in User

Organization Owner

(For: Organization)

Logged-in User

Securable Owner

(For: Share)

Logged-in User

User Owner

(For: User)

Can be associated to:

User

Organization

Authorization

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('locale',
  '<locale id>',
  { role: 'Users', id: '<user id>' }
);

Example Response

200

400

500

{
  "id": "fr",
  "description": "français",
  "created_at": "2014-12-14T23:00:00.000Z",
  "updated_at": "2014-12-14T23:00:00.000Z"
}