Auth0.swift

Comment installer Auth0.swift et commencer à l’utiliser

Vue d’ensemble

SDK Swift pour iOS, macOS, tvOS, watchOS et visionOS qui vous permet d’intégrer Auth0 à vos applications en toute simplicité. Ajoutez la connexion et la déconnexion, stockez les identifiants de manière sécuritaire et accédez aux renseignements de l’utilisateur.

Consultez le dépôt GitHub

Vous migrez depuis la v2? Consultez le guide de migration

Documentation

• Quickstart : montre comment intégrer Auth0.swift dans une application iOS / macOS à partir de zéro.

• Application d’exemple : une application iOS / macOS complète et fonctionnelle que vous pouvez essayer.

• Exemples : explique comment utiliser la plupart des fonctionnalités.

• Documentation de l’API : documentation générée automatiquement à partir des commentaires du code, qui explique toutes les fonctionnalités offertes.

  • Web Auth
  • Credentials Manager
  • Authentication API Client
  • MFA API Client

• FAQ : répond à certaines questions fréquentes sur Auth0.swift.

• Documentation Auth0 : consultez notre site de documentation pour en savoir plus sur Auth0.

Premiers pas

Prérequis

• iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+
• Xcode 16.x
• Swift 6.0+

Consultez la politique de soutien pour savoir quand l’abandon de versions de Xcode, de Swift et de plateforme ne sera pas considéré comme un changement incompatible.

Installation

Swift Package Manager

Ouvrez l’élément de menu suivant dans Xcode :

Fichier > Ajouter des packages…

Dans le champ de recherche Rechercher ou saisir l’URL du package, entrez cette URL :

https://github.com/auth0/Auth0.swift

Ensuite, sélectionnez la règle de dépendance, puis cliquez sur Ajouter un package.

Cocoapods

Ajoutez la ligne suivante dans votre Podfile :

pod 'Auth0', '~> 3.0'

Ensuite, exécutez pod install.

Carthage

Ajoutez la ligne suivante à votre Cartfile :

github "auth0/Auth0.swift" ~> 3.0

Ensuite, exécutez carthage bootstrap --use-xcframeworks.

Configurer le SDK

Accédez au Auth0 Dashboard et créez une nouvelle application Native.

Auth0.swift a besoin du Client ID et du Domain de l’application Auth0 pour communiquer avec Auth0. Vous trouverez ces renseignements dans la page Settings de votre application Auth0. Si vous utilisez un domaine personnalisé, utilisez la valeur de votre domaine personnalisé au lieu de celle indiquée dans la page Settings.

Configurer Client ID et Domain avec un fichier plist

Créez un fichier plist nommé Auth0.plist dans le bundle de votre application avec le contenu suivant :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>ClientId</key>
    <string>{yourAuth0ClientId}</string>
    <key>Domain</key>
    <string>{yourAuth0Domain}</string>
</dict>
</plist>

Configurer Client ID et Domain de façon programmatique

Pour Web Auth

Auth0
    .webAuth(clientId: "{yourAuth0ClientID}", domain: "{yourAuth0Domain}")
    // ...

Pour le client de l’Authentication API

Auth0
    .authentication(clientId: "{yourAuth0ClientID}", domain: "{yourAuth0Domain}")
    // ...

Configurer Web Auth (iOS / macOS)

Configurer l’URL de rappel et l’URL de déconnexion

L’URL de rappel et l’URL de déconnexion sont les URL qu’Auth0 utilise pour rediriger l’utilisateur vers votre application. Auth0 utilise l’URL de rappel après avoir authentifié l’utilisateur, et l’URL de déconnexion après avoir supprimé le cookie de session.

Comme l’URL de rappel et l’URL de déconnexion peuvent être modifiées, vous devez ajouter vos URL aux champs Allowed Callback URLs et Allowed Logout URLs de la page Settings de votre application Auth0. Auth0 pourra ainsi reconnaître ces URL comme valides. Si l’URL de rappel et l’URL de déconnexion ne sont pas définies, les utilisateurs ne pourront pas se connecter ni se déconnecter de l’application et recevront une erreur.

Accédez à la page Settings de votre application Auth0 et ajoutez l’URL correspondante à Allowed Callback URLs et Allowed Logout URLs, selon la plateforme de votre application. Si vous utilisez un domaine personnalisé, remplacez {yourAuth0Domain} par la valeur de votre domaine personnalisé plutôt que par celle indiquée dans la page Settings.

iOS

{yourBundleIdentifier}://{yourAuth0Domain}/ios/{yourBundleIdentifier}/callback

macOS

{yourBundleIdentifier}://{yourAuth0Domain}/macos/{yourBundleIdentifier}/callback

Par exemple, si l’identifiant du bundle de votre application iOS était com.example.MyApp et que votre domaine Auth0 était example.us.auth0.com, cette valeur serait :

com.example.MyApp://example.us.auth0.com/ios/com.example.MyApp/callback

Assurez-vous que le paramètre Méthode d’authentification de l’endpoint de jeton est défini sur None.

Configurer un schéma d’URL personnalisé

Dans Xcode, accédez à l’onglet Info des réglages de la cible de votre application. Dans la section URL Types, cliquez sur le bouton ＋ pour ajouter une nouvelle entrée. Entrez ensuite auth0 dans le champ Identifier et $(PRODUCT_BUNDLE_IDENTIFIER) dans le champ URL Schemes.

Cela enregistre l’identifiant de bundle de votre application comme schéma d’URL personnalisé, afin que l’URL de rappel et l’URL de déconnexion puissent rediriger vers votre application.

Connexion avec Web Auth (iOS / macOS)

Importez le module Auth0 dans le fichier où vous souhaitez afficher la page de connexion.

import Auth0

Ensuite, affichez la page Universal Login dans l’action associée à votre bouton Login.

Auth0
    .webAuth()
    .start { result in
        switch result {
        case .success(let credentials):
            print("Obtained credentials: \(credentials)")
        case .failure(let error):
            print("Failed with: \(error)")
        }
    }

Utilisation d’async/await

do {
    let credentials = try await Auth0.webAuth().start()
    print("Obtained credentials: \(credentials)")
} catch {
    print("Failed with: \(error)")
}

Utilisation de Combine

Auth0
    .webAuth()
    .start()
    .sink(receiveCompletion: { completion in
        if case .failure(let error) = completion {
            print("Failed with: \(error)")
        }
    }, receiveValue: { credentials in
        print("Obtained credentials: \(credentials)")
    })
    .store(in: &cancellables)

Déconnexion de Web Auth (iOS / macOS)

Pour déconnecter l’utilisateur, il faut effacer le Universal Login cookie de session, puis supprimer les identifiants de l’utilisateur de votre application.

Appelez la méthode logout() dans l’action de votre bouton Déconnexion. Une fois le cookie de session effacé, supprimez les identifiants de l’utilisateur.

Auth0
    .webAuth()
    .logout { result in
        switch result {
        case .success:
            print("Session cookie cleared")
            // Supprimer les informations d'identification
        case .failure(let error):
            print("Failed with: \(error)")
        }
    }

Utilisation d’async/await

do {
    try await Auth0.webAuth().logout()
    print("Session cookie cleared")
    // Supprimer les identifiants
} catch {
    print("Failed with: \(error)")
}

Utilisation de Combine

Auth0
    .webAuth()
    .logout()
    .sink(receiveCompletion: { completion in
        switch completion {
        case .finished:
            print("Session cookie cleared")
            // Supprimer les identifiants
        case .failure(let error):
            print("Failed with: \(error)")
        }
    }, receiveValue: {})
    .store(in: &cancellables)

Boîte d’alerte SSO (iOS / macOS)

Consultez la FAQ pour en savoir plus sur la boîte d’alerte qui s’affiche par défaut lorsque vous utilisez Web Auth.

Consultez aussi How to Create a Seamless Mobile SSO (Single Sign-On) Experience in iOS pour un aperçu détaillé.

Prochaines étapes

Découvrez la plupart des fonctionnalités dans Examples :

• Store credentials : Stockez les identifiants de l’utilisateur de façon sécurisée dans le Keychain.
• Check for stored credentials : Vérifiez si l’utilisateur est déjà connecté au démarrage de votre application.
• Retrieve stored credentials : Récupérez les identifiants de l’utilisateur dans le Keychain et renouvelez-les automatiquement s’ils ont expiré.
• Clear stored credentials : Supprimez les identifiants de l’utilisateur pour terminer le processus de déconnexion.
• Retrieve user information : Obtenez les renseignements les plus récents sur l’utilisateur à partir du endpoint /userinfo.