Interface OAuthConfig

OAuth configuration interface

Configuration object for OAuth2 Authorization Code flow with PKCE. Used when initializing OAuth instances for secure authentication. This interface defines all the parameters needed to configure OAuth authentication flows.

Example

const oauthConfig: OAuthConfig = {
  clientId: 'your-client-id',
  redirectUri: 'https://your-app.com/callback',
  scopes: ['read', 'write'],
  state: 'random-state-string'
};

Example

// Minimal OAuth configuration
const oauthConfig: OAuthConfig = {
  redirectUri: 'https://myapp.com/callback'
};

// Full OAuth configuration with custom endpoints
const oauthConfig: OAuthConfig = {
  clientId: 'custom-client-id',
  redirectUri: 'https://myapp.com/callback',
  appURL: 'https://custom-auth.mosaia.ai',
  apiURL: 'https://custom-api.mosaia.ai',
  apiVersion: '2',
  scopes: ['read', 'write', 'admin'],
  state: 'csrf-protection-token'
};
interface OAuthConfig {
    redirectUri?: string;
    appURL?: string;
    scopes?: string[];
    clientId?: string;
    apiURL?: string;
    apiVersion?: string;
    state?: string;
}

Properties

redirectUri? appURL? scopes? clientId? apiURL? apiVersion? state?

Properties

OptionalredirectUri

redirectUri?: string

Redirect URI for the OAuth flow (optional)

OptionalappURL

appURL?: string

App URL for authorization endpoints (optional defaults to https://mosaia.ai)

Optionalscopes

scopes?: string[]

Array of scopes to request (optional)

OptionalclientId

clientId?: string

OAuth client ID (required only if not using default)

OptionalapiURL

apiURL?: string

API URL for API endpoints (required only if not using default)

OptionalapiVersion

apiVersion?: string

API version (required only if not using default)

Optionalstate

state?: string

State parameter for CSRF protection (optional)

Settings

Member Visibility

On This Page

Properties