Create Authorization

LLM-friendly URL

POST

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

API call form

Examples

List of examples

Create an embed token
Create a Login token
Create an API token
Specify parameter overrides when creating an embed token
Specify sticky account overrides when creating an embed token
Specify a global filter when creating an embed token
Specify a chart filter when creating an embed token
Specify an initialization filter on a dropdown or slicer filter item when creating an embed token
Specify an initialization filter on a datefilter item when creating an embed token
Specify an initialization filter on a slider item when creating an embed token
Specify an initialization filter on a chart when creating an embed token
Specify a having filter on a dashboard level when creating an embed token
Specify a having filter on a chart level when creating an embed token
Specify a theme override when creating an embed token
Specify a CSS override when creating an embed token
Specify a feature override when creating an embed token
Specify a currency override when creating an embed token
Specify a timezone override when creating an embed token
Specify column(s) to hide when creating an embed token
Give a tenant edit access to its own fields only
Specify AWS Athena connection override when creating an embed token
Specify BigQuery connection override when creating an embed token
Specify BigQuery dataset(s) connection override when creating an embed token
Specify Clickhouse connection override when creating an embed token
Specify Clickhouse dataset(s) connection override when creating an embed token
Specify Databricks connection override when creating an embed token
Specify Databricks dataset(s) connection override when creating an embed token
Specify ElasticSearch connection override when creating an embed token
Specify ElasticSearch dataset(s) connection override when creating an embed token
Specify MariaDB connection override when creating an embed token
Specify MariaDB dataset(s) connection override when creating an embed token
Specify MongoDB connection override when creating an embed token
Specify MongoDB dataset(s) connection override when creating an embed token
Specify MySQL connection override when creating an embed token
Specify MySQL dataset(s) connection override when creating an embed token
Specify Oracle connection override when creating an embed token
Specify PostgreSQL connection override when creating an embed token
Specify PostgreSQL dataset(s) connection override when creating an embed token
Specify Presto connection override when creating an embed token
Specify Presto dataset(s) connection override when creating an embed token
Specify Redshift connection override when creating an embed token
Specify Redshift dataset(s) connection override when creating an embed token
Specify SAP HANA connection override when creating an embed token
Specify Snowflake connection override when creating an embed token
Specify Snowflake dataset(s) connection override when creating an embed token
Specify SQL Server connection override when creating an embed token
Specify SQL Server dataset(s) connection override when creating an embed token
Specify Azure Synapse connection override when creating an embed token
Specify Trino connection override when creating an embed token
Specify Trino dataset(s) connection override when creating an embed token
Specify Plugin connection override when creating an embed token
Create an embed token with a Luzmo IQ context

Description

This will create an Embed token with a chart filter. A chart filter is a filter that is only applied on the query for that specific widget in the specified dashboard.

expression : Filter expression to apply. Possible values are:
- For numeric columns: ? is null , ? is not null , ? in ? , ? not in ? , ? = ? , ? != ? , ? < ? , ? <= ? , ? > ? , ? >= ?
- For hierarchy columns: ? is null , ? is not null , ? in ? , ? not in ? , ? = ? , ? != ? , ? like ? , ? not like ? , ? starts with ? , ? not starts with ? , ? ends with ? , ? not ends with ?
- For datetime columns: ? is null , ? is not null , ? < ? , ? <= ? , ? > ? , ? >= ? , last_now , last_available , next_now , last_completed , to_date , next_full
value : Value(s) to compare. This field should be omitted for ? is null and ? is not null expressions.
- Value should be an (array of string), numeric or datetime (in RFC 3339 format, like 2018-05-05T12:23:45.000Z ) values, depending on the type of the column.
- For last_now , last_available , next_now , last_completed , to_date , next_full expressions the value should be an object with the unit (year, quarter, month, ...) and quantity (number of units).

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.create('authorization',
  {
    type: "embed",
    username: "< A unique and immutable identifier for your user >",
    name: "< user name >",
    email: "< user email >",
    suborganization: "< a suborganization name >",
    access: {
      collections: [
        {
          id: "<collection_id>",
          inheritRights: "use"
        }
      ]
    },
    filters: [
      {
        clause: "where",
        origin: "chart",
        securable_id: "< dataset id of a dataset used in the dashboard >",
        column_id: "< column id of a column in a dataset used in the dashboard >",
        chart_id: "< chart id of an object contained in the dashboard >",
        expression: "? = ?",
        value: "< value to be applied to the expression >"
      }
    ]
  }
);