Skip to main content
Version: 1.x

Function: fetchCSRFToken()

fetchCSRFToken(page, serviceUrl): Promise<CSRFTokenResult>

Defined in: src/modules/odata.ts:372

Ai

Fetches a CSRF token from an OData service using a HEAD request.

Parameters

page

ODataCSRFPage

Playwright Page with request API (or compatible subset).

serviceUrl

string

The OData service root URL.

Returns

Promise<CSRFTokenResult>

The CSRF token and service URL.

Intent

Fetch a CSRF token for subsequent write operations (POST/PATCH/DELETE).

Guarantee

On success, returns a valid CSRF token string.

Prerequisite

The user session must be authenticated against the OData service.

Ai Context

Sends HEAD request with 'X-CSRF-Token: Fetch' header. Required before any write operation in SAP OData services. Token is typically valid for the session duration.

Sap Module

sap.ui.model.odata.v2.ODataModel — CSRF token handling

Business Context

Obtain CSRF token for secure write operations against SAP OData services.

Throws

ODataError if the token cannot be fetched.

Example

const { token } = await fetchCSRFToken(page, '/sap/opu/odata/sap/API_PRODUCT_SRV/');