This help page is for users in Creator 5. If you are in the newer version (Creator 6), click here. Know your Creator version.

Install the iOS UI framework for the customer app

In addition to the capabilities of the core framework, the UI framework offers predefined view controllers for the components in your Creator application. This allows you to directly include forms, reports, and pages from your Creator app into your iOS app, and build custom UI that can interface with the data in your Creator app.

1. Prerequisites

Note: If your Mac is powered by Apple Silicon (M1, M2, etc.), then you should run Xcode with Rosetta enabled. 

When using Xcode 15 on Apple Silicon Macs (i.e., M1, M2 chips) instead of Intel Macs, we currently only support running in the Simulator under Rosetta destinations.

2. Register your iOS app with Zoho

  1. Edit your Zoho Creator application.
  2. Navigate to its Settings page.
  3. Click Mobile SDK under Developer Tools.
  4. Under the For Customers section, click For iOS. A pane will slide in from the right.
  5. Select the UI & Core library.
  6. Click the Generate Client Credentials. This will generate the client ID, client secret, Portal ID and redirectURI for the iOS app that you want to integrate with your Creator application.

  7. Downloaded the ZCAppInfo.plist file and add it to your project.

3. Install the iOS UI framework for the customer app

  1. Install the Zoho Creator SDK using Pod:

    target 'Demo' do
    pod 'ZohoPortalAuth'
    pod 'ZCUIFramework'
    post_install do |installer|
    installer.generated_projects.each do |project|
    project.targets.each do |target|
    target.build_configurations.each do |config|
    config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
    config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.0'
  2. Add the following to your Objective-C bridging header:

    #import <ZohoPortalAuthKit/ZohoPortalAuth.h> 
  3. Import ZCUIFramework to use Zoho Creator's iOS UI framework:

    import ZCUIFramework
  4. Configure your project with the following code, for example in the SceneDelegate file:

    class SceneDelegate: UIResponder, UIWindowSceneDelegate {
     var window: UIWindow?
      func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
       if let windowScene = scene as? UIWindowScene {
        let window = UIWindow(windowScene: windowScene)
       let scope = ["aaaserver.profile.READ","zohocontacts.userphoto.READ","ZohoContacts.contactapi.READ","ZohoCreator.meta.CREATE","ZohoCreator.meta.READ","ZohoCreator.meta.UPDATE","ZohoCreator.meta.DELETE","","","","","Stratus.stratusop.READ","ZohoCRM.modules.READ","ZohoCRM.users.READ"]
       let clientID = "<Your Client ID>"
       let clientSecret = "<Your Client Secret>"
       let portalId = "<Your Portal id>"
       let urlScheme = "<Your Url Scheme>"
       let accountsUrl = "<Your Portal URL>" // This should be your portal URL. For eg: ​​​​​''
       ZohoPortalAuth.initWithClientID(clientID, clientSecret: clientSecret, portalID: portalId, scope: scope, urlScheme: urlScheme, mainWindow: self.window!, accountsPortalURL: accountsUrl)
       // To verify if the app is already logged in
       ZohoPortalAuth.getOauth2Token {
        (token, error) in
        if token == nil {
         // Not logged in
        } else {
         // App logged in already.
         // Ensure to use the following line of code in your iOS app before you utilize any of Creator SDK’s methods
         Creator.configure(uiDelegate: self)
     func scene(_ scene: UIScene, openURLContexts URLContexts: Set <UIOpenURLContext> ) {
      if let context = URLContexts.first {
       let _ = ZohoPortalAuth.handleURL(context.url,
        sourceApplication: context.options.sourceApplication,
        annotation: context.options.annotation)
    extension SceneDelegate: ZCUIServiceDelegate {
     func oAuthToken(with completion: @escaping AccessTokenCompletion) {
      ZohoPortalAuth.getOauth2Token {
       (token, error) in
       completion(token, error)
     func openURL(for openURLTasks: [OpenUrlTask]) {
      // Get Call back here when openurl have query string "zc_MobileSDK_HandleOpenURL=true"

    Code to allow Zoho Portal login to your iOS app:

    func showLoginScreen() {
     ZohoPortalAuth.presentZohoPortalSign( in: {
      (token, error) in
      if token != nil {
       //login success

    Code to provision logout from Zoho Portal:

    func logout() {
     ZohoPortalAuth.revokeAccessToken {
      (error) in
      if error == nil {
       //Logout Successfully
      else {
       //Error Occurred
  5. Add values for the following keys in info.plist. These are mandatory parameters for Apple's privacy compliance because their respective services are used in the UI framework.

    'NSCameraUsageDescription', 'NSContactsUsageDescription', 'NSLocationWhenInUseUsageDescription', 'NSMicrophoneUsageDescription', 'NSPhotoLibraryUsageDescription' and 'NSPhotoLibraryAddUsageDescription'


  1. I'm a M1 Mac user and I'm facing issues while adding dependencies. What should I do?
    To proceed further, please use the arch=x86_64 pod install command.


  • Please refer to our iOS SDK documentation for detailed information about the various SDK methods.
  • Familiarize yourself with Mobile SDK for iOS by trying out our sample application here.​
  • To configure push notifications for iOS, refer here.

Still can't find what you're looking for?

Write to us: