How to build Xiaomi sign-in with iOS (Swift)

For our new friends:

Logto is an Auth0 alternative designed for modern apps and SaaS products. It offers both Cloud and Open-source services to help you quickly launch your identity and management (IAM) system. Enjoy authentication, authorization, and multi-tenant management all in one.

We recommend starting with a free development tenant on Logto Cloud. This allows you to explore all the features easily.

In this article, we will go through the steps to quickly build the Xiaomi sign-in experience (user authentication) with iOS (Swift) and Logto.

Prerequisites

A running Logto instance. Check out the introduction page to get started.
Basic knowledge of iOS (Swift).
A usable Xiaomi account.

Create an application in Logto

Logto is based on OpenID Connect (OIDC) authentication and OAuth 2.0 authorization. It supports federated identity management across multiple applications, commonly called Single Sign-On (SSO).

To create your Native app application, simply follow these steps:

Open the Logto Console. In the "Get started" section, click the "View all" link to open the application frameworks list. Alternatively, you can navigate to Logto Console > Applications, and click the "Create application" button.
In the opening modal, click the "Native app" section or filter all the available "Native app" frameworks using the quick filter checkboxes on the left. Click the "iOS (Swift)" framework card to start creating your application.
Enter the application name, e.g., "Bookstore," and click "Create application".

🎉 Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application.

Integrate iOS (Swift) with Logto

Add Logto SDK as a dependency

Use the following URL to add Logto SDK as a dependency in Swift Package Manager.

https://github.com/logto-io/swift.git

Since Xcode 11, you can directly import a Swift package w/o any additional tool.

We do not support Carthage and CocoaPods at the time due to some technical issues.

Carthage

Carthage needs a xcodeproj file to build, but swift package generate-xcodeproj will report a failure since we are using binary targets for native social plugins. We will try to find a workaround later.

CocoaPods

CocoaPods does not support local dependency and monorepo, thus it's hard to create a .podspec for this repo.

Init LogtoClient

Initialize the client by creating a LogtoClient instance with a LogtoConfig object.

ContentView.swift
import Logto
import LogtoClient

let config = try? LogtoConfig(
  endpoint: "<your-logto-endpoint>", // E.g. http://localhost:3001
  appId: "<your-app-id>"
)
let client = LogtoClient(useConfig: config)

info:

By default, we store credentials like ID Token and Refresh Token in the Keychain. Thus the user doesn't need to sign in again when he returns.

To turn off this behavior, set usingPersistStorage to false:

let config = try? LogtoConfig(
  // ...
  usingPersistStorage: false
)

Before we dive into the details, here's a quick overview of the end-user experience. The sign-in process can be simplified as follows:

Your app invokes the sign-in method.
The user is redirected to the Logto sign-in page. For native apps, the system browser is opened.
The user signs in and is redirected back to your app (configured as the redirect URI).

This authentication process follows the OpenID Connect (OIDC) protocol, and Logto enforces strict security measures to protect user sign-in.
If you have multiple apps, you can use the same identity provider (Logto). Once the user signs in to one app, Logto will automatically complete the sign-in process when the user accesses another app.

To learn more about the rationale and benefits of redirect-based sign-in, see Logto sign-in experience explained.

Configure redirect URI

Let's switch to the Application details page of Logto Console. Add a Redirect URI io.logto://callback and click "Save changes".

info:

The Redirect URI in iOS SDK is only for internal use. There's NO NEED to add a Custom URL Scheme until a connector asks.

note:

Before calling .signInWithBrowser(redirectUri:), make sure you have correctly configured Redirect URI in Admin Console.

You can use client.signInWithBrowser(redirectUri:) to sign in the user and client.signOut() to sign out the user.

For example, in a SwiftUI app:

ContentView.swift
struct ContentView: View {
  @State var isAuthenticated: Bool

  init() {
    isAuthenticated = client.isAuthenticated
  }

  var body: some View {
    VStack {
      if isAuthenticated {
        Button("Sign Out") {
          Task { [self] in
            await client.signOut()
            isAuthenticated = false
          }
        }
      } else {
        Button("Sign In") {
          Task { [self] in
            do {
              try await client.signInWithBrowser(redirectUri: "${
                props.redirectUris[0] ?? 'io.logto://callback'
              }")
              isAuthenticated = true
            } catch let error as LogtoClientErrors.SignIn {
              // error occured during sign in
            } catch {
              // other errors
            }
          }
        }
      }
    }
  }
}

Checkpoint: Test your application

Now, you can test your application:

Run your application, you will see the sign-in button.
Click the sign-in button, the SDK will init the sign-in process and redirect you to the Logto sign-in page.
After you signed in, you will be redirected back to your application and see the sign-out button.
Click the sign-out button to clear token storage and sign out.

Add Xiaomi connector

To enable quick sign-in and improve user conversion, connect with iOS (Swift) as an identity provider. The Logto social connector helps you establish this connection in minutes by allowing several parameter inputs.

To add a social connector, simply follow these steps:

Navigate to Console > Connectors > Social Connectors.
Click "Add social connector" and select "Xiaomi".
Follow the README guide and complete required fields and customize settings.

note:

If you are following the in-place Connector guide, you can skip the next section.

Set up Xiaomi OAuth app

Get started

Create a developer account at Xiaomi Open Platform
Visit Xiaomi Account Service
Create a new application if you don't have one

Configure Xiaomi OAuth application

Visit Xiaomi Account Service
Configure OAuth settings:
- Open the application you want to use for login, click on "Callback URL" (if you haven't edited the callback URL, it will display as "Enabled")
- Add authorization callback URL: ${your_logto_origin}/callback/${connector_id}
- connector_id can be found on the top of the connector details page in Logto Console
Get AppID and AppSecret from the application details page
Fill in the clientId and clientSecret fields in Logto Console with the values from step 3
Optional configuration:
- skipConfirm: Whether to skip the Xiaomi authorization confirmation page when user is already logged in to Xiaomi account, defaults to false

Scopes description

By default, the connector requests the following scope:

1: Read user profile

Available scopes:

Scope Value	Description	API Interface
1	Get user profile	user/profile
3	Get user open_id	user/openIdV2
1000	Get Xiaomi router info	Mi Router
1001	Access all Xiaomi router info	Mi Router
2001	Access Xiaomi cloud calendar	Mi Cloud
2002	Access Xiaomi cloud alarm	Mi Cloud
6000	Use Mi Home smart home service	Mi Home
6002	Add third-party devices to Mi Home	Mi Home
6003	Alexa control Xiaomi devices	Mi Home
6004	Third-party service access to Xiaomi devices	Mi Home
7000	Follow Yellow Pages service account	Mi Cloud
11000	Get Xiaomi cloud photos	Mi Cloud
12001	Save app data to Mi Cloud	Mi Cloud
12005	Use health ECG service	Health
16000	Get Mi Wallet passes	app/get_pass
20000	Enable XiaoAI voice service	XiaoAI
40000	Enable cloud AI service	Internal Use

Multiple scopes can be configured by separating them with spaces, e.g.: 1 3 6000.

Test Xiaomi connector

That's it. Don't forget to Enable social sign-in in the sign-in experience.

Save your configuration

Double check you have filled out necessary values in the Logto connector configuration area. Click "Save and Done" (or "Save changes") and the Xiaomi connector should be available now.

Once you create a social connector successfully, you can enable it as a "Continue with Xiaomi" button in Sign-in Experience.

Navigate to Console > Sign-in experience > Sign-up and sign-in.
(Optional) Choose "Not applicable" for sign-up identifier if you need social login only.
Add configured Xiaomi connector to the "Social sign-in" section.

Testing and Validation

Return to your iOS (Swift) app. You should now be able to sign in with Xiaomi. Enjoy!

Create an application in Logto​

Integrate iOS (Swift) with Logto​

Add Logto SDK as a dependency​

Carthage​

CocoaPods​

Init LogtoClient​

Sign in​

Regarding redirect-based sign-in​

Configure redirect URI​

Sign-in and sign-out​

Checkpoint: Test your application​

Add Xiaomi connector​

Set up Xiaomi OAuth app​

Get started​

Configure Xiaomi OAuth application​

Scopes description​

Test Xiaomi connector​

Save your configuration​

Enable Xiaomi connector in Sign-in Experience​

Testing and Validation​

Further readings​