Enable Certificate-Based Authentication in your MDK Client

In the MDKClient_SDK folder, you will find the template.mdkproject folder.

It is recommended that you copy this folder to another location so that you can to use it for future builds. Copy and paste it anywhere, and then rename the template to MDKCertApp.mdkproject.

Next, you will need to update the BrandedSettings.json and MDKProject.json files as needed for your client. Go into the MDKCertApp.mdkproject folder.

Open the MDKProject.json file and update it as needed. This file has some build-time configurations such as the application name, version and bundle ID.

AppDisplayName: This is the name of the application on the home screen of the device.

AppName: This is the name of the folder where the client is created.

BundleID: It should be a unique identifier for your application. This controls if the client can be installed side by side with other applications on the device. Two applications with the same Bundle ID cannot be installed at the same time on a device. For iOS this is the Identifier (AppID) that is registered in Apple Developer account since that determines if the application can be installed alongside other applications. If the XCode project is set up to use Automatically manage signing then when building, XCode will automatically generate a signing profile for the specified bundle id. Without matching them, trying to run the custom client in iOS device will result in failure. In Android, it is known as application ID.

UrlScheme: Allows you to specify a custom URL scheme which opens the client. This value is provided in step 2 for Redirect URL. If the URL includes connection settings as URL parameters, these settings will override the ones used by the client. This value mdkcertclient needs to match the value provided in step 2 for the Redirect URL. This value also needs to be unique across applications on your device. If the value is not unique the wrong application may be referenced when redirecting.

Open the BrandedSettings.json file and update the ConnectionSettings with the values for your MDK application in Mobile Services. To update the AppId, ClientId, ServerUrl, AuthorizationEndPointUrl, RedirectUrl and TokenUrl in the ConnectionSettings block, navigate to the Mobile Services admin UI, click myapp.mdk.certs > Settings > Client Settings > Info tab, copy the highlighted block and paste it in BrandedSettings.json.

You also need to update the AllowCerts property to true into the ConnectionSettings block.

AllowCerts property allows MDK client to access the certificate on the device during on-boarding if requested by the Identity provider (IdP). You can find more information about this property in help documentation.

To find the correct URLs for your client, you should navigate to Mobile Services admin UI and find your MDK application that you want to link to this client.

Regarding other properties: Debug settings: The settings in the DebugSettings property are for development use and should not be enabled in a production setting.

Log Settings: Set this to the log level to be used when the client is launched.

Demo: If you want to access the app in the demo mode, you can configure required settings.

If you are connecting to AliCloud accounts, you will also need to add your custom domains under URLWhitelist property in the same file. You can find more details in documentation.

Add mdkcertclient://oauth2redirect in the AllowedDomains property.

If you are connecting to AliCloud accounts, you will also need to add your custom domains under the same AllowedDomains property. You can find more details in documentation.

In the last section of BrandedSettings.json file, make these changes:

In the MDKClient_SDK folder, you will find the template.mdkproject folder.

It is recommended that you copy this folder to another location so that you can to use it for future builds. Copy and paste it anywhere, and then rename template to MDKCertApp.mdkproject.

Next, you will need to update the MDKProject.json and BrandedSettings.json files as needed for your client. Go into the MDKCertApp.mdkproject folder.

Open the MDKProject.json file and update it as needed. This file has some build-time configurations such as the application name, version and bundle ID.

AppDisplayName: This is the name of the application on the home screen of the device.

AppName: This is the name of the folder where the client is created.

BundleID: It should be a unique identifier for your application. This controls if the client can be installed side by side with other applications on the device. Two applications with the same Bundle ID cannot be installed at the same time on a device. In Android, it is known as application ID.

UrlScheme: Allows you to specify a custom URL scheme which opens the client. This value is provided in step 2 for Redirect URL. If the URL includes connection settings as URL parameters, these settings will override the ones used by the client. This value mdkcertclient needs to match the value provided in step 2 for the Redirect URL. This value also needs to be unique across applications on your device. If the value is not unique the wrong application may be referenced when redirecting.

Open the BrandedSettings.json file and update the ConnectionSettings with the values for your MDK application in Mobile Services. To update the AppId, ClientId, ServerUrl, AuthorizationEndPointUrl, RedirectUrl and TokenUrl in the ConnectionSettings block, navigate to the Mobile Services admin UI, click myapp.mdk.certs > Mobile Security Exchange > Info tab, copy the highlighted block and paste it in BrandedSettings.json.

You also need to update the AllowCerts property to true into the ConnectionSettings block.

AllowCerts property allows MDK client to use the certificate. You can find more information about this property in help documentation. To access the certificate on the device during on-boarding if requested by the Identity provider (IdP).

To find the correct URLs for your client, you should navigate to Mobile Services admin UI and find your MDK application that you want to link to this client.

Regarding other properties: Debug settings: The settings in the DebugSettings property are for development use and should not be enabled in a production setting.

Log Settings: Set this to the log level to be used when the client is launched.

Demo: If you want to access the app in the demo mode, you can configure required settings.

Add mdkcertclient://oauth2redirect in the AllowedDomains property.

If you are connecting to AliCloud accounts, you will also need to add your custom domains under the same AllowedDomains property. You can find more details in documentation.

In the last section of BrandedSettings.json file, make these changes:

Run ./create-client.command to create the client. You will be asked to provide the path to the .mdkproject file. You can also provide optional arguments such as output directory and log verbosity. You can run create-client.command --help to find out how to specify these options as arguments.

You can run the create-client command from any directory. The resulting MDK client will be created in the directory where the create-client command is run from.

You will be asked whether you would like to build for iOS or android or all?

All option was chosen in this tutorial as you will learn how to create the MDK client for iOS and Android.

Once the create-client.command script executed successfully, you will see Application ready message in terminal console.

You will also find your MDK Client app created under the MDKClient_SDK folder.

Run ./create-client.cmd to create the client. You will be asked to provide the path to the .mdkproject file. You can also provide optional arguments such as output directory and log verbosity. You can run create-client.cmd --help to find out how to specify these options as arguments.

You can run the create-client command from any directory. The resulting MDK client will be created in the directory where the create-client command is run from.

Once the create-client.cmd script executed successfully, you will see Application ready message in terminal console.

You will also find your app created under the MDKClient_SDK folder.