OneLogin Node.js SDK

A TypeScript/JavaScript SDK for the OneLogin API, providing a simple interface to manage users, roles, apps, MFA, and more.

Installation

npm install @onelogin/sdk

Quick Start

const { DefaultApi, GenerateTokenRequest } = require('@onelogin/sdk');

const api = new DefaultApi();

// Step 1: Generate an access token
const tokenRequest = new GenerateTokenRequest();
tokenRequest.grantType = 'client_credentials';

// Replace with your OneLogin API credentials
const CLIENT_ID = 'your_client_id_here';
const CLIENT_SECRET = 'your_client_secret_here';

// Authorization format: "client_id:{CLIENT_ID}, client_secret:{CLIENT_SECRET}"
const authorization = `client_id:${CLIENT_ID}, client_secret:${CLIENT_SECRET}`;

api.generateToken(authorization, tokenRequest, (error, data) => {
  if (error) {
    console.error('Error:', error);
  } else {
    const accessToken = data.access_token;
    
    // Step 2: Use the token for API calls
    const authHeader = `bearer:${accessToken}`;
    
    // Example: List users (first 100)
    api.listUsers(authHeader, 100, (err, users) => {
      if (err) {
        console.error('Error listing users:', err);
      } else {
        console.log('Users:', users);
      }
    });
  }
});

Authentication

The OneLogin API uses OAuth 2.0 for authentication. You'll need:

1. Client ID and Client Secret from your OneLogin admin portal
2. Generate an access token using the generateToken method
3. Use the token in the authorization parameter for subsequent API calls

API Reference

The SDK provides access to the full OneLogin API v2. Key features include:

• User Management: Create, update, delete, and list users
• Role Management: Manage roles and role assignments
• App Management: Configure and manage applications
• MFA: Enroll, verify, and manage multi-factor authentication
• Authorization Servers: Configure OAuth/OIDC settings
• Risk Management: Track events and manage risk rules

For complete API documentation, see the OneLogin API documentation.

Development

Build the project:

npm install
npm run build

Support

This is an open source project maintained by OneLogin. For issues, questions, or contributions, please use GitHub Issues.

For official OneLogin support, contact OneLogin Support.

License

MIT License - see LICENSE file for details.