New features and enhancements
External authentication via JSON Web Token
The Orchestration SDK now supports relaying JSON Web Tokens (JWTs) for authentication to enable external authentication with other services. The JWT is issued by the back end integrating the Orchestration SDK server and is passed through the Orchestration SDK server to the client SDKs. Then, you can forward the token to the target service, allowing the Orchestration SDK to act as a trusted external authenticator and eliminating the need to maintain separate authentication credentials.
This causes the following API changes:
For both Android and iOS, a new callback object is available, RemoteAuthenticationResult, which contains the remoteSessionState and the optional authToken parameters.
Android
Changes in the RemoteAuthenticationCallback object:
// RemoteAuthenticationCallback
//Before:
void onRemoteAuthenticationSuccess(SuccessSessionState state);
//After:
void onRemoteAuthenticationSuccess(RemoteAuthenticationResult result);iOS
Changes in the RemoteAuthenticationDelegate object:
//RemoteAuthenticationDelegate
//Before:
func orchestrator(_ orchestrator: Orchestrator, didFinishRemoteAuthenticationFlowWith state: RemoteSessionState)
//After:
func orchestrator(_ orchestrator: Orchestrator, didFinishRemoteAuthenticationFlowWith result: RemoteAuthenticationResult)Authentication flow validation feedback
A new, optional OrchestrationCommand parameter is now available for the abort/error callback of RemoteAuthenticationDelegate , RemoteTransactionDelegate , and OrchestrationErrorDelegate.
If the OrchestrationCommand parameter is present in the abort/error callbacks, you should transmit it to the Customer Application Server to notify it about the authentication result and to end the flow on the server side as well.
As a result of this change, the public API changed as follows:
Android
// RemoteAuthenticationCallback
//Before:
void onRemoteAuthenticationAborted();
//After:
void onRemoteAuthenticationAborted(@Nullable String command);// RemoteTransactionCallback
//Before:
void onRemoteTransactionAborted();
//After:
void onRemoteTransactionAborted(@Nullable String command);// OrchestrationErrorCallback
//Before:
void onOrchestrationError(OrchestrationError error);
//After:
void onOrchestrationError(OrchestrationError error, @Nullable String command);iOS
// protocol RemoteAuthenticationDelegate
// Before:
func orchestratorDidAbortRemoteAuthentication(_ orchestrator: Orchestrator)
// After:
func orchestratorDidAbortRemoteAuthentication(_ orchestrator: Orchestrator, command: String?)// protocol RemoteTransactionDelegate
// Before:
func orchestratorDidAbortRemoteTransaction(_ orchestrator: Orchestrator)
// After:
func orchestratorDidAbortRemoteTransaction(_ orchestrator: Orchestrator, command: String?)// protocol OrchestrationErrorDelegate
// Before
func orchestrator(_ orchestrator: Orchestrator, didReceiveError error: OrchestrationError)
// After
func orchestrator(_ orchestrator: Orchestrator, didReceiveError error: OrchestrationError, command: String?)Supported platforms
For information on the supported operating systems and platforms supported by Mobile Security Suite and the affiliated SDKs, see Supported platforms.
Known issues
For information on issues that have not yet been resolved in this release of Mobile Security Suite, see Known issues.
API reference documentation and sample applications
To learn more about the public APIs and their functions, exceptions, and error codes, refer to the technical documentation that is included in the product package for each SDK and each platform. In the product package, you can also find the sample applications provided for each platform to see examples of how the SDKs can be used.
These sample apps are intended only to demonstrate basic scenarios and SDK usage. They are not designed to be copied directly into production projects!
Third party licenses
For information on third party dependencies associated with Mobile Security Suite and the affiliated SDKs in this release, see Third party licenses.