Class SSO

SSO API client for the Mosaia SDK

Provides single sign-on (SSO) authentication functionality for OAuth providers. This allows users to authenticate using external OAuth accounts (Google, GitHub, etc.).

Example

import { Mosaia } from 'mosaia-node-sdk';

const mosaia = new Mosaia({ apiKey: 'your-api-key' });
const sso = mosaia.sso;

// Authenticate with SSO
const result = await sso.authenticate({
  mosaia_user: { id: 'user-id' },
  oauth_account: {
    type: 'oauth',
    provider: 'google'
  }
});

console.log('SSO token:', result.token);

Constructors

constructor

Methods

authenticate

Constructors

constructor

Methods

authenticate

  • authenticate(request: SSORequestInterface): Promise<SSOResponseInterface>

    Authenticate using SSO

    Authenticates a user using an external OAuth provider account. Returns a token that can be used for subsequent API requests.

    Parameters

    • request: SSORequestInterface

      SSO authentication request object containing:

      • mosaia_user: User information object with id property
      • oauth_account: OAuth account information object with:
        • type: OAuth account type (e.g., 'oauth')
        • provider: OAuth provider name (e.g., 'google', 'github')

    Returns Promise<SSOResponseInterface>

    Promise resolving to SSO response with authentication token

    Example

    // Authenticate with Google OAuth
    const result = await sso.authenticate({
      mosaia_user: { id: 'user-123' },
      oauth_account: {
        type: 'oauth',
        provider: 'google'
      }
    });

    // Use the token for authentication
    const mosaia = new Mosaia({
      session: {
        accessToken: result.token,
        authType: 'oauth'
      }
    });

    Throws

    When authentication fails

Settings

Member Visibility

On This Page

Constructors
Methods