Release notes v3.x
3.1.2
- [iOS] Replaced deprecated methods on ClientBuilder and deprecated ONGClient with SharedClient.
3.1.1
- [iOS] Wrapper SDK now uses the latest iOS native SDK 12.3.6
3.1.0
Improvements
- [Android] Wrapper SDK now uses the latest Android Native SDK 12.0.0
- [iOS] Wrapper SDK now uses the latest iOS native SDK 12.3.4
- [iOS & Android] Support for stateless registration feature
- Added
registerStatelessUser
method.
- Added
With this update new fields were added to the config model class. You should update your SDK Configurator to 5.3.0 or higher.
3.0.3
Bugfixes
- [iOS] Fixed a bug where
ClosePinAuthenticationEvent
wouldn't be emitted, when user cancelled biometric authenticator registration.
3.0.2
Bugfixes
- [iOS] Fix a crash on iOS on failing resource requests.
3.0.1
Bugfixes
- Changed access modifier of a native api in order to hide it from the SDK user.
3.0.0
See v3.0.0. for an overview of all the breaking changes when upgrading to version 3.0.0
Improvements
-
General Documentation Improvements
- Added specific documentation for the call back functions which can be found in Callbacks
- Extended the documentation regarding certain user flows such as registration, authentication, OTP, and changePin
-
Increase iOS SDK version to 12.2.2
-
Events are now propagated using streams. An in depth explanation of the new approach can be found in Event handling.
-
Previously events were thrown using the OneginiEventListener Class where a user would overwrite functions to handle events. This approach has been reworked to use a StreamController which can be listened to. Each Listener will now have the ability to respond to an OWEvent using the global owEventStreamController.
- startApplication does no longer requires a OneginiListener parameter.
-
We removed the following deprecated events:
- eventOther
- openPinAuthenticator
- eventError
-
We have renamed the following events to better represent the event occurrence:
- changed openPinRequestScreen into OpenPinCreationEvent
- changed closePin into ClosePinCreationEvent
- changed openPinScreenAuth into openPinAuthenticationEvent
- changed closePinAuth into closePinAuthenticationEvent
- changed openFingerprintScreen into openFingerprintEvent
- changed closeFingerprintScreen into closeFingerprintEvent
- changed eventInitCustomRegistration into i__nitCustomRegistration__Event
- changed eventFinishCustomRegistration into finish__CustomRegistration__Event
- changed ReceivedFingerprintEvent into NextFingerprintAuthenticationAttempt
- changed NextAuthenticationAttemptEvent into NextPinAuthenticationAttemptEvent
- changed eventError into several more specific events:
- PinNotAllowedEvent as described in Create Pin
-
Reworked functions that required BuildContext. Now all functions are independent of this context and therefore will not require this parameter anymore. Reworked functions:
- handleRegisteredUserUrl
- getIdentityProviders
- authenticateUser
- changePin
- setPreferredAuthenticator
- Fingerprints's acceptAuthenticationRequest
- OTP's acceptAuthenticationRequest
- Pin Authentication's acceptAuthenticationRequest
- Pin Registration's acceptAuthenticationRequest
-
Updated all documentation related to events to better reflect the desired functionality flow
-
Allow Absolute Paths for resource requests:
-
Now it is possible to perform resource requests using multiple resource base urls besides the one that is defined within the tokenserver config file. This is possible as long as a valid certificate is included in the config for certificate pinning. Instructions on how to enable this can be found here.
-
Functions Rework: We reworked many functions and replaced their return values and required params
-
Introduced New Custom Objects
- OWUserProfile
- OWCustomInfo
- OWIdentityProvider
-
- Contains more information compared to the previous Authenticator object
- OWRegistrationResponse
- OWAuthenticationAttempt
- ResourceRequests
-
These functions now return or use the previously described objects:
-
Updated functions to only resolve instead of returning an unneeded value :
- setPreferredAuthenticator now only resolves instead of returning boolean
- deregisterBiometricAuthenticator now only resolves instead of returning boolean
- logout now only resolves instead of returning boolean
- authenticateDevice now only resolves instead of returning boolean
- validatePinWithPolicy now only resolves instead of returning boolean
- authenticateUserImplicitly now only resolves instead of returning string
- deregisterUser now only resolves instead of returning boolean
-
removed isDefault from the userProfile object, which is replaced for OWUserProfile.
-
Updated parameters
- handleRegisteredUserUrl now takes a non-nullable string for the url
- Custom registration's submitSuccessAction now does not require an Identity-provider ID
- Custom registration's submitErrorAction now does not require an Identity-provider ID
-
Updated Errors
- getAppToWebSingleSignOn now returns actual underlying errorcode instead of generic error
- iOS + Android: registerAuthenticator will now give native errors instead of wrongly returning authenticatorNotFound when the authenticator is already registered.
-
OneginiPinRegistrationCallback.acceptAuthenticationRequest has been reworked and does not take a map anymore as a second argument but just a pin which is a String, the optional isCustomAuthenticator has been removed
-
Reworked Resource requests
- Updated documentation for Secure resource access and added a reference guide for resourceRequest.
-
Renamed functions to better reflect functionality
getUnauthenticatedResource
torequestResourceUnauthenticated
getResourceAnonymous
torequestResourceAnonymous
getResource
torequestResourceAuthenticated
getResourceImplicit
torequestResourceImplicit
-
Added generic function named
requestResource
-
Reworked error codes, see Error codes for a complete list.
-
Reworked
mobileAuthWithOtp
and updated the documentation which can be found here.- Users are now forced to "enroll" for mobile authentication before they can use OTP. Previously, this was done automatically through the SDK when trying to authenticate with OTP. The functionality to enroll is described in enrollMobileAuthentication.
- For consistency reasons we renamed
mobileAuthWithOtp
tohandleMobileAuthWithOtp
handleMobileAuthWithOtp
now only resolves successfully withvoid
instead ofString?
, see handleMobileAuthWithOtp.- [bugfix] correctly throw an error when starting a second otp mobile authentication flow
- [bugfix] throw error on iOS when user is not authenticated
-
Reworked several authentication/authenticator methods
-
Removed:
getRegisteredAuthenticators
getAllAuthenticators
registerAuthenticator
-
Added:
deregisterBiometricAuthenticator
registerBiometricAuthenticator
getBiometricAuthenticator
getPreferredAuthenticator
-
Changed: (now using OWAuthenticatorType)
setPreferredAuthenticator
authenticateUser
-