Skip to main content
Version: 1.x

Interface: SAPAuthConfig

SAP system authentication configuration.

Remarks​

Contains all fields needed to authenticate against any SAP system variant (OnPrem, BTP, Cloud SAML, Office365, API, Certificate). Optional fields use | undefined due to exactOptionalPropertyTypes.

Example​

const config: SAPAuthConfig = {
  url: 'https://my-sap.example.com',
  username: 'admin',
  password: 'secret',
  client: '100',
};

Properties​

certificateKeyPath?​

readonly optional certificateKeyPath?: string

Path to client certificate key.

certificatePath?​

readonly optional certificatePath?: string

Path to client certificate for certificate-based auth.

client?​

readonly optional client?: string

SAP client number (optional, OnPrem only).

language?​

readonly optional language?: string

SAP language code (optional, e.g., 'EN').

loginEndpoint?​

readonly optional loginEndpoint?: string

Custom login endpoint path for API-based auth.

password​

readonly password: string

Password for authentication.

staySignedIn?​

readonly optional staySignedIn?: boolean

Whether to click "Stay signed in" on Office365.

storageStatePath?​

readonly optional storageStatePath?: string

Path to save storage state for session reuse.

strategy?​

readonly optional strategy?: string

Auth strategy name override (auto-detected if not provided).

subdomain?​

readonly optional subdomain?: string

BTP subdomain for multi-tenant auth.

timeout?​

readonly optional timeout?: number

Auth timeout in ms (default from PramanConfig).

url​

readonly url: string

SAP system URL (e.g., 'https://my-sap.example.com').

username​

readonly username: string

Username for authentication.