auth_uae_pass library
Classes
- AuthUaePass
- UaePassAccessTokenRequest
- UaePassAuthData
- Consolidated result of a full UAE PASS authentication flow (Status + Token + Profile).
- UaePassAuthRequest
- UaePassAuthResult
- UaePassCallbackParser
- UaePassConfig
- Configuration for UAE PASS authentication.
- UaePassIdHubEndpoints
- UAE PASS idhub OAuth2-related URLs (staging vs production).
- UaePassIntrospectRequest
-
Token introspection (RFC 7662) via UAE PASS idhub
introspect. - UaePassIntrospectResult
-
Parsed introspection response (
active, claims, metadata). - UaePassLogger
- Internal logger for the UAE PASS SDK.
- UaePassLogoutRequest
- UaePassTokenValidationDecision
- Outcome of applying UaePassTokenValidationRules to an introspect response.
- UaePassTokenValidationDenialCode
- Reasons for denying access (SP validation guidelines; check in order).
- UaePassTokenValidationRules
- Rules the SP applies after calling Verify Access Token (introspect).
- UaePassUserProfile
- UaePassUserProfileRequest
- UaePassUserToken
Enums
- UaePassEnvironment
- UaePassErrorCode
- UaePassEvent
- Events emitted by the UAE PASS SDK for analytics and tracking.
- UaePassFlowStatus
- UaePassLogLevel
- Log levels for the UAE PASS SDK.
- UaePassSopLevel
Constants
- kUaePassAcrMobileOnDevice → const String
- UAE PASS mobile authentication API (acr values, deep links). See: https://docs.uaepass.ae/feature-guides/authentication/mobile-application/guide/api
- kUaePassAcrWebFallback → const String
- Used when the UAE PASS app is not installed (web / push flow). User enters identifier in webview; confirmation via push on another device (see mobile API).
- kUaePassDocumentsNotVerifiedErrorCode → const String
- kUaePassScopeGeneral → const String
-
Standard
scopevalue (general profile). - kUaePassScopeProfileType → const String
- Visitor integration — additional claims (first authentication only per docs).
- kUaePassScopeUnifiedId → const String
- kUaePassVisitorFirstAuthScope → const String
-
Space-separated
scopefor visitor integration first authentication call (unifiedIDandprofileType).
Functions
-
applyMobileAcrValues(
Uri authorizeUri, {required bool uaePassAppInstalled}) → Uri -
Sets or replaces
acr_valueson the authorize URL per the mobile API. -
applyVisitorIntegrationScopes(
Uri authorizeUri) → Uri -
Merges kUaePassVisitorFirstAuthScope into the existing
scopeonauthorizeUri. -
buildSpResumeUri(
{required Uri spRedirectUri, String? deepLinkScheme, required String resumeAuthnPath, required String wrappedUrl}) → Uri -
yourapp:///resume_authn?url=<originalSuccessOrFailureUrl>(SP scheme + resume path). -
evaluateIntrospectAccess(
UaePassIntrospectResult? introspect, UaePassTokenValidationRules rules) → UaePassTokenValidationDecision - Applies SP validation in chronological order (mandatory first):
-
isSpResumeAuthnCallback(
{required Uri uri, required Uri spRedirectUri, String? deepLinkScheme, required String resumeAuthnPath}) → bool -
isUaePassAppInstalled(
UaePassEnvironment environment) → Future< bool> - Probes whether the UAE PASS app is installed.
-
isUaePassNativeScheme(
Uri uri) → bool -
nestedUrlFromResumeCallback(
Uri uri) → String? -
parseUaePassErrorCode(
String? errorCode) → UaePassErrorCode? -
rewriteUaePassDeepLinkForSp(
{required Uri uaePassDeepLink, required Uri spRedirectUri, String? deepLinkScheme, String? uaePassScheme, required String resumeAuthnPath}) → Uri -
Rewrites
uaepass*://...?successURL=...&failureURL=...so success/failure point at the SP app.
Exceptions / Errors
- UaePassCancelledException
- Thrown when authentication is cancelled by the user.
- UaePassDocumentsNotVerifiedException
- Thrown when the user's documents are not verified on UAE PASS.
- UaePassException
- Base class for all UAE PASS related exceptions.
- UaePassProfileException
- Thrown when there is an error fetching the user profile.
- UaePassTokenException
- Thrown when there is an error during the OAuth2 token exchange.