Interface: SAPAuthConfig

Defined in: src/auth/auth-types.ts:119

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

Defined in: src/auth/auth-types.ts:137

Path to client certificate key.

---

certificatePath?

readonly optional certificatePath: string

Defined in: src/auth/auth-types.ts:135

Path to client certificate for certificate-based auth.

---

client?

readonly optional client: string

Defined in: src/auth/auth-types.ts:127

SAP client number (optional, OnPrem only).

---

language?

readonly optional language: string

Defined in: src/auth/auth-types.ts:129

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

---

loginEndpoint?

readonly optional loginEndpoint: string

Defined in: src/auth/auth-types.ts:133

Custom login endpoint path for API-based auth.

---

password

readonly password: string

Defined in: src/auth/auth-types.ts:125

Password for authentication.

---

staySignedIn?

readonly optional staySignedIn: boolean

Defined in: src/auth/auth-types.ts:141

Whether to click "Stay signed in" on Office365.

---

storageStatePath?

readonly optional storageStatePath: string

Defined in: src/auth/auth-types.ts:145

Path to save storage state for session reuse.

---

strategy?

readonly optional strategy: string

Defined in: src/auth/auth-types.ts:131

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

---

subdomain?

readonly optional subdomain: string

Defined in: src/auth/auth-types.ts:139

BTP subdomain for multi-tenant auth.

---

timeout?

readonly optional timeout: number

Defined in: src/auth/auth-types.ts:143

Auth timeout in ms (default from PramanConfig).

---

url

readonly url: string

Defined in: src/auth/auth-types.ts:121

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

---

username

readonly username: string

Defined in: src/auth/auth-types.ts:123

Username for authentication.