iOS Swift: Login
By Martin Walsh
This tutorial demonstrates how to add user login to a Swift application using Auth0. We recommend you to Log in to follow this quickstart with examples configured for your account.
I want to integrate with my app
15 minutesI want to explore a sample app
2 minutesGet a sample configured with your account settings or check it on Github.
Configure Auth0
Get Your Application Keys
When you signed up for Auth0, a new application was created for you, or you could have created a new one.
You will need some details about that application to communicate with Auth0. You can get these details from the Application Settings section in the Auth0 dashboard.
You need the following information:
- Client ID
- Domain
Add your credentials in the Auth0.plist file. If the file does not exist in your project yet, create it:
<!-- Auth0.plist -->
<?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>YOUR_CLIENT_ID</string>
<key>Domain</key>
<string>YOUR_AUTH0_DOMAIN</string>
</dict>
</plist>
Configure Callback URLs
A callback URL is a URL in your application where Auth0 redirects the user after they have authenticated.
You need to whitelist the callback URL for your app in the Allowed Callback URLs field in your Application Settings. If you do not set any callback URL, your users will see a mismatch error when they log in.
In your application's Info.plist file, register your iOS Bundle identifier as a custom scheme:
<!-- Info.plist -->
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleTypeRole</key>
<string>None</string>
<key>CFBundleURLName</key>
<string>auth0</string>
<key>CFBundleURLSchemes</key>
<array>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
</array>
</dict>
</array>
Go to your Dashboard Settings and make sure that the Allowed Callback URLs field contains the following callback URL:
{PRODUCT_BUNDLE_IDENTIFIER}://YOUR_AUTH0_DOMAIN/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
e.g. If your bundle identifier was com.company.myapp and your domain was company.auth0.com then this value would be
com.company.myapp://company.auth0.com/ios/com.company.myapp/callback
Start the Authentication
Universal Login is the easiest way to set up authentication in your application. We recommend using it for the best experience, best security and the fullest array of features.
Install Dependencies
Carthage
If you are using Carthage, add the following to your Cartfile:
github "auth0/Auth0.swift" ~> 1.13
Then, run carthage bootstrap.
Cocoapods
If you are using Cocoapods, add the following to your Podfile:
use_frameworks!
pod 'Auth0', '~> 1.13'
Then, run pod install.
Add the Callback
For Auth0 to handle the authentication callback, update your AppDelegate file.
First, import the Auth0 module:
import Auth0
Then, add the following UIApplicationDelegate method:
// AppDelegate.swift
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any]) -> Bool {
return Auth0.resumeAuth(url, options: options)
}
Implement Login
First, import the Auth0 module in the file where you want to present the login page:
import Auth0
Then, present the login screen:
// HomeViewController.swift
Auth0
.webAuth()
.scope("openid profile")
.audience("https://YOUR_AUTH0_DOMAIN/userinfo")
.start {
switch $0 {
case .failure(let error):
// Handle the error
print("Error: \(error)")
case .success(let credentials):
// Do something with credentials e.g.: save them.
// Auth0 will automatically dismiss the login page
print("Credentials: \(credentials)")
}
}
This adds the profile scope to enable retrieving the User Profile.
After the user authenticates, their information is returned in a credentials object.