Class AuthError

constructor

• new AuthError(options: AuthErrorOptions): AuthError

  Creates a new AuthError instance.

  Parameters

  • options: AuthErrorOptions

    Auth error construction options including strategy and login URL.

  Returns AuthError

  Example

  import { AuthError } from '#core/errors/auth-error.js';
  
  const error = new AuthError({
    message: 'SAML authentication failed',
    attempted: 'Login to SAP BTP',
    strategy: 'btp-saml',
    loginUrl: 'https://accounts.sap.com/login',
  });
  Copy

ReadonlyloginUrl

Readonlystrategy

toAIContext

• toAIContext(): AIErrorContext & {
      loginUrl: string
      | undefined;
      strategy: string | undefined;
  }

  Returns structured context for AI agents with authentication diagnostics.

  Returns AIErrorContext & { loginUrl: string | undefined; strategy: string | undefined }

  Base AI context plus strategy and loginUrl fields to help diagnose authentication configuration issues.

  Example

  const context = error.toAIContext();
  // context.strategy, context.loginUrl available
  // Send to LLM for auth troubleshooting suggestions
  Copy

toJSON

• toJSON(): SerializedPramanError & {
      loginUrl: string
      | undefined;
      strategy: string | undefined;
  }

  Serializes the error to a JSON-safe object with authentication fields.

  Returns SerializedPramanError & {
      loginUrl: string | undefined;
      strategy: string | undefined;
  }

  Base fields plus strategy and loginUrl.

  Example

  const json = error.toJSON();
  // json.strategy === 'btp-saml'
  // json.loginUrl === 'https://accounts.sap.com/login'
  Copy