Module HAAPI iOS UIKit Documentation

API reference for the IdsvrHaapiUIKit framework.

Looking for guides, concepts, and how-tos? See the HAAPI SDK developer guide (authored in haapi-sdk-docs).

Requirements

Xcode 27 no longer builds for iOS versions below 15.0, which is why 15.0 is the floor. Releases 5.6.0 and earlier support iOS 14.0 or later.

Identity-server addresses

A flow's HAAPI requests go only to the host of the configured base URL or authorization endpoint: a form submission or automatic redirection to any other host ends with the foreign_haapi_target error, and a followed link must target the base URL host or it ends with non_haapi_link. A host containing a non-ASCII character matches nothing, so configure an internationalized host in its ASCII (xn--) form. The base URL, the authorization endpoint, the token endpoint, a revocation endpoint and — with dynamic client registration — the client registration endpoint must use https, or starting the flow and any OAuthLifecycle token operation fail with insecure_haapi_configuration (see the SDK documentation). For a local development server, call HaapiUIKitConfigurationBuilder.setAllowInsecureHttpEndpoints(value: true), which admits http and no other scheme; it defaults to false, App Transport Security still applies, and it never widens where a request may go.

HaapiUI Previewer (experimental)

Renders themed HAAPI screens and component galleries in Xcode Previews. Distributed as Swift source next to this framework: add the IdsvrHaapiUIKitPreviewer Swift Package Manager product or CocoaPods pod to your app (or copy the HaapiUIPreviewer/ folder from the distribution repository). Debug builds get the previewer; Release builds compile it to an empty module, so it never ships in your app. Setup and usage are covered in the developer guide's Preview Tools page.

Theming reference

Per-component style definitions — every themable key, its type, and default value.

UI Extensibility reference

Per-class extensibility hooks for customizing or replacing the bundled view controllers.

Reference Documentation

Protocols

Structs

Classes

Enums

Extensions

Typealiases