iOS Quickstart

Use this guide to add ThunderID authentication to an iOS application using the ThunderID iOS SDK for SwiftUI.

What You Will Learn

Create a new Xcode project

Install the ThunderIDSwiftUI Swift package

Add working sign-in and sign-out using SwiftUI components

Display the signed-in user's name

Prerequisites

About 15 minutes

Xcode 15 or later

iOS 16+ deployment target

Example Source Code

Check out the complete iOS Quickstart Sample in the ThunderID repository.

Run ThunderID

Start a local ThunderID instance. Pick the method that works best for you:

$npx thunderid

Requires Node.js 18+

Full install guide →

Once it's running, the console is available at https://localhost:8090/console.

Create an Application

Sign in to the Console.

Test User
If you used the default setup, sign in to the Console as admin with the password generated during setup and printed to the setup output (unless you supplied your own).
Navigate to Applications, and click Add Application.
Under Application Type, select Mobile App.
Enter a name (e.g. My iOS App) and create an application. The rest of the settings can stay at their defaults.
Copy the Client ID from the General tab. You'll add the redirect URI in the next step after configuring your URL scheme.

Create an iOS App

In Xcode, create a new project using the iOS > App template. Choose SwiftUI as the interface and Swift as the language.

note

If you already have an existing iOS project, skip this step.

Install ThunderIDSwiftUI

In Xcode, go to File > Add Package Dependencies and enter the package URL:

https://github.com/thunderid/thunderid-ios-sdk

When prompted to choose package products, select ThunderIDSwiftUI. This includes the core <ProductName /> client as a dependency.

note

If you manage dependencies with CocoaPods, add the following to your Podfile instead:

pod 'ThunderIDSwiftUI'

Configure a Callback URL Scheme

ThunderID redirects back to your app after sign-in and sign-out using a custom URL scheme. You need to register this scheme in two places.

1. Register the scheme in your app

Open your app's Info.plist and add a URL scheme under URL Types. For example:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>io.thunderid.b2c</string>
    </array>
  </dict>
</array>

2. Register the redirect URI in the ThunderID console

In the console, open your registered application and add the following as an Allowed Redirect URI:

io.thunderid.b2c://callback

Add the same value as an Allowed Post-Logout Redirect URI:

io.thunderid.b2c://logout

Initialize the SDK

Open your app's entry point (the file that conforms to App) and apply the .thunderIDProvider(config:) modifier to your root view. This injects a ThunderIDState environment object into all child views.

MyApp.swift
import SwiftUI
import ThunderIDSwiftUI

@main
struct MyApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
                .thunderIDProvider(config: ThunderIDConfig(
                    baseUrl: "https://localhost:8090",
                    clientId: "<your-client-id>",
                    scopes: ["openid", "profile", "email"],
                    afterSignInUrl: "io.thunderid.b2c://callback",
                    afterSignOutUrl: "io.thunderid.b2c://logout",
                    applicationId: "<your-application-id>"
                ))
        }
    }
}

Configuration

Replace <your-client-id> with the Client ID and <your-application-id> with the Application ID from your ThunderID application settings.

Configuration Parameters

Parameter	Description
`baseUrl`	Your ThunderID instance URL. Must use HTTPS.
`clientId`	The Client ID from your ThunderID application
`scopes`	OAuth 2.0 scopes to request. Include `"openid"` at minimum.
`afterSignInUrl`	The redirect URI to return to after sign-in
`afterSignOutUrl`	The redirect URI to return to after sign-out
`applicationId`	The Application ID used for embedded (app-native) sign-in flows

The ThunderID iOS SDK provides SignedIn and SignedOut guard views for conditional rendering, a SignIn component for the embedded sign-in flow, and a SignOutButton for sign-out.

Replace the contents of ContentView.swift with:

ContentView.swift
import SwiftUI
import ThunderIDSwiftUI

struct ContentView: View {
    @EnvironmentObject var state: ThunderIDState

    var body: some View {
        Group {
            if !state.isInitialized {
                ProgressView("Loading...")
            } else {
                SignedIn {
                    HomeView()
                } fallback: {
                    AuthView()
                }
            }
        }
    }
}

Create AuthView.swift to display the sign-in form:

AuthView.swift
import SwiftUI
import ThunderIDSwiftUI

struct AuthView: View {
    var body: some View {
        VStack(spacing: 24) {
            Text("Welcome")
                .font(.largeTitle)
                .bold()

            SignIn(applicationId: "<your-application-id>")
                .padding()
        }
        .padding()
    }
}

Display User Profile Information

Create HomeView.swift to show the authenticated user's name and a sign-out button:

HomeView.swift
import SwiftUI
import ThunderIDSwiftUI

struct HomeView: View {
    @EnvironmentObject var state: ThunderIDState

    var body: some View {
        NavigationStack {
            VStack(spacing: 24) {
                if let user = state.user {
                    Text("Welcome, \(user.displayName ?? user.email ?? "User")!")
                        .font(.title2)
                        .bold()

                    Text(user.email ?? "")
                        .foregroundStyle(.secondary)
                }

                SignOutButton()
                    .buttonStyle(.borderedProminent)
            }
            .padding()
            .navigationTitle("Home")
        }
    }
}

Run the App

In Xcode, select an iOS 16+ simulator and press Run (⌘R).

Test credentials

You'll need a user to sign in with. If you haven't created one yet, open https://localhost:8090/console, navigate to Users, and add a test user with an email and password.

Success

You should see the sign-in form. Enter your test user credentials and tap Submit. After successful authentication, the home screen displays the user's name and a Sign Out button.