Upgrade Guides#
Migration notes covering cross-cutting changes (DPoP nonce auto-management, the HaapiLogger setLogType migration) and per-framework major-version upgrades. Read the relevant guide before bumping a HAAPI SDK to a new major version.
Cross-cutting vs per-framework. Cross-cutting upgrades apply on all platforms and layers at the same time; per-framework upgrades describe the breaking changes within a single framework’s major-version bump. The relevant guide is usually called out in the framework’s release notes.
Cross-Cutting Migrations#
Changes that are not tied to a single framework’s major version.
| Page | Topic |
|---|---|
| Upgrade — DPoP Nonce Auto-Management | The SDK now manages dpop-nonce automatically; what to remove from your code |
| Upgrade — HaapiLogger setLogType Migration | Deprecated isXxxEnabled flags replaced by setLogType / setLevel with severity ordering |
Upgrade — Link handling by rel and type | Classify a link before acting on it, and followLink refuses an off-host target |
| Upgrade — Server Key Pinning | A pinned mutual-TLS server is validated by the platform before the pin is compared; untrusted roots and plain-http requests are refused (iOS and Android) |
| Upgrade — Redirects Are Refused | Every HTTP redirect of an SDK request is refused, and nothing is sent to its target (Android and iOS) |
| Upgrade — HAAPI request target hardening | Every HAAPI request is checked against the configured server, an http address is refused at construction unless you opt in, and transport redirects are not followed (Android and iOS) |
| Upgrade — Android UIWidget Flow Launch and Redirect URI | HaapiFlowActivity is no longer exported: start it with HaapiFlowActivity.Contract, and declare the redirect URI with manifest placeholders (Android UIWidget 5.8.0) |
| Upgrade — iOS WebAuthn buildParameters | The iOS SDK WebAuthn steps build their continue parameters with buildParameters, as on Android; formattedParametersForRegistration and formattedParametersForAssertion are deprecated (iOS SDK and UIKit) |
Per-Framework Major Versions#
Breaking changes scoped to a single framework’s major-version transition.
| Page | Framework |
|---|---|
| Upgrade — iOS UIKit v5 | IdsvrHaapiUIKit 5.x — breaking API changes from 4.x |
| Upgrade — Android UIWidget v5 | IdsvrHaapiUIWidget 5.x — breaking API changes from 4.x |
| Upgrade — React Native vN | @curity/identityserver-haapi-react-native-sdk major-version upgrade placeholder, populated on each major release |
Platform Requirement Changes#
A raised minimum OS or toolchain version for one platform’s frameworks. These are breaking for anyone below the new floor even when they arrive in a minor release, because a project that cannot meet the requirement cannot link the release at all.
| Page | Platform |
|---|---|
| Upgrade — iOS minimum version 15.0 | iOS 5.7.0 — iOS 15.0 required (Xcode 26 or later); the Haapi device-support probe removed |