iOS での認証方法の管理

Auth0 My Account API を使用して、ユーザーが MFA 認証要素、パスキー、リカバリーコードを登録、確認、削除できる全画面 UI を iOS でレンダリングします。

iOS SDK 用の Universal Components には、My Account API を使用して、登録、検証、一覧表示、削除に関するすべてのフローを処理する SwiftUI ビュー、MyAccountAuthMethodsView コンポーネントが含まれています。

My Account API の認証方法管理機能を利用して、ユーザーの認証方法を管理するための包括的な UI をレンダリングします。

MyAccountAuthMethodsView コンポーネントを使用すれば、ナビゲーションの制御、エンドポイントの呼び出し、state の管理を行う必要はありません。

​

設定要件

MyAccountAuthMethodsView コンポーネントをレンダリングする前に、セルフサービスのアカウントセキュリティインターフェースを構築するに従って SDK をインストールし、Auth0 テナントを設定して、トークンプロバイダーで SDK を初期化してください。

MyAccountAuthMethodsView コンポーネントは、初期化された SDK から設定、トークンプロバイダー、パスキー設定を取得します。

​

サポート対象の認証要素

このコンポーネントは、My Account API で設定されているすべての認証方法を処理します。各認証要素の画面には、コンポーネントで有効なテーマが適用されます。詳細については、スタイルとテーマのカスタマイズを参照してください。

認証要素	コンポーネントがレンダリングする内容	SDK に関する注意事項
Email OTP	メールアドレスの入力 → 6 桁の OTP 検証	プラットフォームの OTP 自動入力機能 (iOS QuickType) により、OTP フィールドに自動入力されます。
SMS OTP	国番号の選択 + 電話番号の入力 → 6 桁の OTP 検証	システムキーボードによる自動入力は通常どおり利用できます。
TOTP (認証器アプリ)	手動入力用キー付きの QR コード → 6 桁の OTP 検証	標準の otpauth:// payload をレンダリングします。QR コードにカスタムブランドロゴを埋め込むことはできません。
プッシュ通知	Auth0 Guardian でスキャンするための QR コード → 「承認待ち」状態	エンドユーザーには公開版の Auth0 Guardian アプリが必要です。ブランド化した Guardian SDK ビルドを使用する Enterprise のお客様は、コンポーネント外で独自のインストールリンクを表示する必要があります。
パスキー	説明画面 → OS の生体認証プロンプト → リスト内の登録済みエントリ	Apple Associated Domains (iOS 16.6+) が必要です。プラットフォームの設定については、専用ページを参照してください。
リカバリーコード	コピー操作と「コードを保存しました」の確認を備えた、一度だけ表示されるコードのリスト	コードはユーザーに表示されるだけで、呼び出し元に返されることはありません。クリップボードへのコピーには、プラットフォーム標準のクリップボード API を使用します。

​

はじめに

通常は設定画面へのナビゲーションリンクの配下に、MyAccountAuthMethodsView コンポーネントをSwiftUIの階層内の任意の場所に追加します。

SettingsView.swift

import SwiftUI
import Auth0UniversalComponents

struct SettingsView: View {
    var body: some View {
        NavigationStack {
            List {
                NavigationLink(destination: MyAccountAuthMethodsView()) {
                    Label("Authentication Methods", systemImage: "lock.shield")
                }
            }
            .navigationTitle("Account Settings")
        }
    }
}

Swift view はイニシャライザのパラメータを受け取りません。動作をカスタマイズするには、SwiftUI の view 修飾子と環境値を使用します。

​

パラメータ

MyAccountAuthMethodsView コンポーネントでは、次のモディファイア値と環境値を使用できます。

モディファイア / 環境値	型	目的
.auth0Theme(_:)	Auth0Theme	デザイントークン (色、タイポグラフィ、間隔、角丸、サイズ) をオーバーライドします。詳細については、スタイルとテーマのカスタマイズを参照してください。
.embeddedInNavigationStack()	—	ビューがホスト NavigationStack に埋め込まれていることを指定し、SDK が独自のスタックを作成する代わりに、ホストのスタックにプッシュするようにします。
\.hostNavigationPath	Binding<NavigationPath>	SDK がホストナビゲーションスタックにデスティネーションをプッシュする際に使用する環境バインディングです。.embeddedInNavigationStack() を呼び出す場合は必須です。

​

カスタマイズ

テーマはコンポーネント全体に適用され、各認証要素画面には現在のテーマが継承されます。

トークンの全カタログとダークモードのパターンについては、スタイルとテーマのカスタマイズを参照してください。

​

ホスト側のNavigationStackに埋め込む

デフォルトでは、MyAccountAuthMethodsViewコンポーネントが独自のNavigationStackを管理します。

アプリケーションですでにナビゲーションスタックを使用している場合、2つ目のスタックをネストすると、戻るボタンやスワイプで戻るジェスチャーが正しく機能しなくなります。代わりに、MyAccountAuthMethodsViewコンポーネントを既存のスタックに埋め込んでください。

NavigationStack(path: $path) {
    List {
        NavigationLink("Authentication methods", value: "auth-methods")
    }
    .navigationDestination(for: String.self) { value in
        if value == "auth-methods" {
            MyAccountAuthMethodsView()
                .embeddedInNavigationStack()
        }
    }
}
.environment(\.hostNavigationPath, $path)

埋め込みモードを使用するには、次の2つの要件を満たす必要があります。

• MyAccountAuthMethodsView コンポーネントに .embeddedInNavigationStack() 修飾子を追加し、内部スタックが作成されないようにします。

• 外側の NavigationStack に \.hostNavigationPath 修飾子を追加し、SDK がどのパスバインディングにプッシュするかを認識できるようにします。

SDK では、独自のルートに対して型安全なナビゲーションコントローラーが必要なアプリケーション向けに、Router ヘルパークラスも提供しています。

SDK 内部のナビゲーションを制御するために使用する必要はありません。アプリケーションの画面にも同じパターンを適用したい場合にのみ使用してください。

​

ローカライゼーション

iOS 向け Universal Components には、ローカライズされた文字列は含まれていません。ユーザー向けの文言は英語です。

ローカライゼーションが連携の障壁となる場合は、ui-components-ios リポジトリで機能リクエストを送信してください。

​

制限事項

• iOS では認証要素を単独で扱うコンポーネントは提供されません。すべての認証要素は 認証方法の管理 コンポーネント内にレンダリングされます。アプリケーション内の別の場所で、単一の認証要素を登録、検証、削除するためのパブリック API はありません。
• 単独で使用できる一覧表示／削除コンポーネントはありません。SDK には、登録済みの認証要素を一覧表示したり、コンポーネント外で削除したりするためのパブリックコンポーネントは用意されていません。管理機能をすべて利用するには、認証方法の管理 コンポーネントを使用してください。

​

詳細

セルフサービスのアカウントセキュリティインターフェースを構築する

SDK を初期化し、トークンプロバイダーを Auth0 テナントに接続します。

スタイルとテーマをカスタマイズする

Auth0 のデザイントークンシステムを使用して、色、タイポグラフィ、間隔、角丸、サイズのトークンをオーバーライドします。