Authentication: Get Access Token (JavaScript)

This script retrieves a bearer token from the Sigma API using client credentials authentication.

IN THIS RECIPE

Description
How to use these code samples
All samples in Github

xxxxxxxxxx
module.exports = getBearerToken;
// This script responds with a bearer token and is called from each of the other scripts in this project. 
// Variables are in .env and need to be updated for your Sigma hosted environment and API keys
​
​
​
// 1: Load environment variables from a specific .env file for configuration
require('dotenv').config({ path: 'sigma-api-recipes/.env' });
​
// 2: Import Axios for making HTTP requests
const axios = require('axios');
​
// 4: Load use-case specific variables from environment variables
const authURL = process.env.authURL; // The URL for your Sigma Instance
const clientId = process.env.CLIENT_ID; // Your client ID
const secret = process.env.SECRET; // Your API secret
​
// Asynchronous function to obtain a bearer token using the credentials grant type
async function getBearerToken() {
  try {
    // Prepare the data for the request using URLSearchParams to encode it as application/x-www-form-urlencoded
    const requestData = new URLSearchParams({
      grant_type: 'client_credentials', // Indicates the grant type for OAuth 2.0
      client_id: clientId, // Your client ID
      client_secret: secret, // Your client secret
    });
​
    // Log the constructed URL before sending the request
      console.log(`URL sent to Sigma: ${authURL}`);
​

🔒

Authentication: Get Access Token (JavaScript)

This script retrieves a bearer token from the Sigma API using client credentials authentication.

4 Steps

🔌

Connections: List all (Javascript)

This script lists all connections in alphabetically order by name.

3 Steps

🔌

Connections: Sync All Tables in Schema (Javascript)

This script automates the synchronization of tables within a specified schema (Snowflake).

3 Steps

🖇️

Embedding - Generate Embed Path for Member - All Workbooks (JavaScript)

This recipe fetches a list of workbooks available to a specified memberId and generates a valid embed URL for each one.

3 Steps

👥

Members: Bulk Deactivate

This script deactivates and deletes all users found using a single parameter that can be configured as a wildcard.

3 Steps

👤

Members: Change Email Address (JavaScript)

This script automates the process of changing a member's email address in Sigma.

3 Steps

👤

Members: Create New (JavaScript)

This script creates a new member, workspace and the associated grants in Sigma by sending a POST request to the API endpoints required.

3 Steps

👤

Member - Get Member Details (JavaScript)

This script retrieves the details of a specific member based on the memberId provided in the .env file.

3 Steps

👤

Members: List All (JavaScript)

This script retrieves all members from the Sigma API by making GET requests with pagination until all members are fetched.

3 Steps

👤

Member: Onboarding (JavaScript)

This script automates the onboarding process for a new member by creating them and executing a series of actions in a specific order.

3 Steps

👤

Members: Recent Workbooks (JavaScript)

This script fetches recent documents and folders for a specified member from the Sigma API.

3 Steps

👤

Members: Update (JavaScript)

This script updates the account type of a member on the Sigma platform by sending a PATCH request to the API with the new member type.

3 Steps

👥

Teams: Bulk Assign Members (JavaScript)

This script is designed to bulk assign existing members to a specific team, utilizing the members' emails as identifiers.

3 Steps

👥

Teams: Bulk Remove Members (JavaScript)

This script is designed to bulk remove existing members to a specific team, utilizing the members' emails as identifiers.

3 Steps

📖

Workbook - Copy Workbook to Member "My Documents" Folder (JavaScript)

This script automates the process of copying a specific workbook for a designated user in Sigma.

3 Steps

📖

Workbook: Export to CSV with Date Range Parameters (JavaScript)

This recipe demonstrates how to trigger an export job for a specific workbook and include a parameter-based date range for the data.

3 Steps

📖

Workbook: Export to PDF (JavaScript)

This script triggers an export to PDF job and downloads the export once ready.

3 Steps

📖

Get Column Names by Page and Element (Javascript)

This script automates the process of retrieving column names for all elements in each page of a workbook in Sigma.

3 Steps

📖

Workbook: Initiate Materialization Job (JavaScript)

This script initiates a materialization job for a specified workbook.

3 Steps

📖

Workbook: List All (JavaScript)

This script fetches all workbooks accessible to a specific member based on their memberId.

3 Steps

📖

Workbooks: List all Input Tables (JavaScript)

This script searches through all workbooks for specific elements of the type "input-table" and logs details about them.

3 Steps

📖

Workbook: Pagination (JavaScript)

This script fetches all workbooks from the Sigma API, handling pagination for large datasets.

3 Steps

📖

Workbook: Shared with Me (JavaScript)

This script fetches all workbooks shared to a specific member based on their memberId.

3 Steps

📖

Workbooks - Update owner (Javascript)

This script updates the ownership of a specified workbookId.

3 Steps