Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.
;
};
export const sections = [{
id: "configure-auth0",
title: "Configure Auth0"
}, {
id: "install-the-sdk",
title: "Install the SDK"
}, {
id: "configure-the-sdk",
title: "Configure the SDK"
}, {
id: "add-login-to-your-application",
title: "Add login to your application"
}, {
id: "add-logout-to-your-application",
title: "Add logout to your application"
}, {
id: "access-user-profile-information",
title: "Access user profile information"
}];
This guide demonstrates how to add authentication and access user profile information in any iOS / macOS app using
the [Auth0.swift](https://github.com/auth0/Auth0.swift) SDK.
To use this quickstart, you need to:
To use Auth0 services, you need an application set up in the Auth0 Dashboard. The Auth0 application is where you
will configure how you want authentication to work for the app you are developing.
### Configure an Auth0 application
Use the interactive selector to create a new Auth0 application or select an existing **Native** Auth0
application. Auth0 assigns every application an alphanumeric, unique Client ID that your app uses to call Auth0
APIs through the SDK.
Any settings you configure using this quickstart automatically update your Auth0 application in the [Dashboard](https://manage.auth0.com/#/), which is where you
can manage your applications in the future.
If you would rather explore a complete configuration, you can view a sample app instead.
### Configure callback and logout URLs
Auth0 invokes the callback and logout URLs to redirect users back to your app. Auth0 invokes the callback URL
after authenticating the user and the logout URL after removing the session cookie. If you do not set the callback
and login URLs, users will not be able to log in and out of the app, and your app will produce an error.
On iOS 17.4+ and macOS 14.4+ it is possible to use Universal Links as callback and logout URLs. When
enabled, Auth0.swift will fall back to using a custom URL scheme on older iOS / macOS versions.
**This feature requires Xcode 15.3+ and a paid Apple Developer account.**
Add the following URLs to **Callback URLs** and **Logout URLs**, depending on the platform of your app. If
you have a custom domain, use this instead of your Auth0
tenant’s domain.
#### iOS
```
https://dev-gja8kxz4ndtex3rq.us.auth0.com/ios/YOUR_BUNDLE_IDENTIFIER/callback,
YOUR_BUNDLE_IDENTIFIER://dev-gja8kxz4ndtex3rq.us.auth0.com/ios/YOUR_BUNDLE_IDENTIFIER/callback
```
#### macOS
```
https://dev-gja8kxz4ndtex3rq.us.auth0.com/macos/YOUR_BUNDLE_IDENTIFIER/callback,
YOUR_BUNDLE_IDENTIFIER://dev-gja8kxz4ndtex3rq.us.auth0.com/macos/YOUR_BUNDLE_IDENTIFIER/callback
```
For example, if your iOS bundle identifier was `com.example.MyApp` and your Auth0 domain was
`example.us.auth0.com`, then this value would be:
```
https://example.us.auth0.com/ios/com.example.MyApp/callback,
com.example.MyApp://example.us.auth0.com/ios/com.example.MyApp/callback
```
### Configure the associated domain
This step requires a paid Apple Developer account. It is needed to use Universal Links as callback and
logout URLs. Skip this step to use a custom URL scheme instead.
#### Configure the Team ID and bundle identifier
Go to the [settings page](https://manage.auth0.com/dashboard/us/#/applications/) of your Auth0 application, scroll to the end, and open **Advanced
Settings > Device Settings**. In the **iOS** section, set **Team ID** to your [Apple Team ID](https://developer.apple.com/help/account/manage-your-team/locate-your-team-id/) and **App ID** to your app's bundle identifier.
This will add your app to your Auth0 tenant's `apple-app-site-association` file.
#### Add the associated domain capability
In Xcode, go to the **Signing and Capabilities** [tab](https://developer.apple.com/documentation/xcode/adding-capabilities-to-your-app#Add-a-capability) of your app's target settings, and press the **+
Capability** button. Then select **Associated Domains**.
Next, add the following [entry](https://developer.apple.com/documentation/xcode/configuring-an-associated-domain#Define-a-service-and-its-associated-domain) under **Associated Domains**:
```
webcredentials:labs-fundtraining.us.auth0.com
```
If you have a custom domain, use this instead of your
Auth0 tenant’s domain.
For the associated domain to work, your app must be signed with your team certificate **even when
building for the iOS simulator**. Make sure you are using the Apple Team whose Team ID is configured
in the settings page of your Auth0 application.
### Using the Swift Package Manager
Open the following menu item in Xcode:
**File > Add Package Dependencies...**
In the **Search or Enter Package URL** search box enter this URL:
```
https://github.com/auth0/Auth0.swift
```
Then, select the dependency rule and press **Add Package**.
For further reference on SPM, check its [official documentation](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app).
### Using Cocoapods
Add the following line to your `Podfile`:
```
pod 'Auth0', '~> 2.0'
```
Then, run `pod install`.
For further reference on Cocoapods, check their [official documentation](https://guides.cocoapods.org/using/getting-started.html).
### Using Carthage
Add the following line to your `Cartfile`:
```
github "auth0/Auth0.swift" ~> 2.0
```
Then, run `carthage bootstrap --use-xcframeworks`.
For further reference on Carthage, check their [official documentation](https://github.com/Carthage/Carthage#getting-started).
The Auth0.swift SDK needs your Auth0 **domain** and **Client ID**. You can find these values in the [settings
page](https://manage.auth0.com/dashboard/us/#/applications/) of your Auth0 application.
* **domain**: The domain of your Auth0 tenant. If you have a custom domain, use this instead of your Auth0 tenant’s
domain.
* **Client ID**: The alphanumeric, unique ID of the Auth0 application you set up earlier in this quickstart.
Create a `plist` file named `Auth0.plist` in your app bundle containing the Auth0 domain
and Client ID values.
You can also configure the SDK programmatically. Check the [README](https://github.com/auth0/Auth0.swift#configure-client-id-and-domain-programmatically) to learn more.
##### Checkpoint
You configured the Auth0.swift SDK. Run your app to verify that it is not producing any errors related to
the SDK.
Import the `Auth0` module in the file where you want to present the login page. Then, present the Universal Login page in the action of your **Login**
button.
You can use async/await or Combine instead of the callback-based API. Check the [README](https://github.com/auth0/Auth0.swift#web-auth-login-ios--macos) to learn more.
##### Checkpoint
Press the **Login** button and verify that:
* An [alert box](https://github.com/auth0/Auth0.swift#sso-alert-box-ios--macos) shows up asking for consent.
* Choosing \*\*Continue \*\*opens the Universal Login page in a Safari modal.
* You can log in or sign up using a username and password or a social provider.
* The Safari modal closes automatically afterward.
Now that you can log in to your app, you need a way to [log out](https://auth0.com/docs/authenticate/login/logout). In the action of your **Logout** button, call the `clearSession()`
method to clear the Universal Login session cookie.
##### Checkpoint
Press the **Logout** button and verify that:
* An alert box shows up asking for consent.
* Choosing \*\*Continue \*\*opens a page in a Safari modal.
* The Safari modal closes automatically soon after.
The `Credentials` instance you obtained after logging in includes an ID token. The ID token contains the profile information
associated with the logged-in user, such as their email and profile picture. You can use these details to
personalize the user interface of your app.
The Auth0.swift SDK includes a [utility](https://github.com/auth0/JWTDecode.swift) for decoding [JWTs](https://jwt.io/) like the ID token. Start by importing the `JWTDecode` module in
the file where you want to access the user profile information. Then, use the `decode(jwt:)` method to
decode the ID token and access the claims it contains.
You can retrieve the latest user information with the `userInfo(withAccessToken:)` method.
Check the [EXAMPLES](https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#retrieve-user-information) to learn more.
##### Checkpoint
Verify that you can access the `email`, `picture`, or any other claim after you have logged in.
## Next Steps
Excellent work! If you made it this far, you should now have login, logout, and user profile information running in your application.
This concludes our quickstart tutorial, but there is so much more to explore. To learn more about what you can do with Auth0, check out:
* [Auth0 Dashboard](https://manage.auth0.com/dashboard/us/dev-gja8kxz4ndtex3rq) - Learn how to configure and manage your Auth0 tenant and applications
* [Auth0.swift SDK](https://github.com/auth0/Auth0.swift) - Explore the SDK used in this tutorial more fully
* [Auth0 Marketplace](https://marketplace.auth0.com/) - Discover integrations you can enable to extend Auth0’s functionality
```xml Auth0.plist lines theme={null}
ClientIdmz9iNEIo2PHu7oeh8QRt19ndTyyCIgaiDomaindev-gja8kxz4ndtex3rq.us.auth0.com
```
```swift MainView.swift lines highlight={20-31} theme={null}
import SwiftUI
import Auth0
struct MainView: View {
@State var user: User?
var body: some View {
if let user = self.user {
VStack {
ProfileView(user: user)
Button("Logout", action: self.logout)
}
} else {
Button("Login", action: self.login)
}
}
}
extension MainView {
func login() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link callback URL on iOS 17.4+ / macOS 14.4+
.start { result in
switch result {
case .success(let credentials):
self.user = User(from: credentials.idToken)
case .failure(let error):
print("Failed with: \(error)")
}
}
}
func logout() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link logout URL on iOS 17.4+ / macOS 14.4+
.clearSession { result in
switch result {
case .success:
self.user = nil
case .failure(let error):
print("Failed with: \(error)")
}
}
}
}
```
```swift ProfileView.swift lines theme={null}
```
```swift User.swift lines highlight={11-14} theme={null}
import JWTDecode
struct User {
let id: String
let email: String
let picture: String
}
extension User {
init?(from idToken: String) {
guard let jwt = try? decode(jwt: idToken),
let id = jwt.subject,
let email = jwt["email"].string,
let picture = jwt["picture"].string
else { return nil }
self.id = id
self.email = email
self.picture = picture
}
}
```
```swift MainView.swift lines highlight={20-31} theme={null}
import SwiftUI
import Auth0
struct MainView: View {
@State var user: User?
var body: some View {
if let user = self.user {
VStack {
ProfileView(user: user)
Button("Logout", action: self.logout)
}
} else {
Button("Login", action: self.login)
}
}
}
extension MainView {
func login() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link callback URL on iOS 17.4+ / macOS 14.4+
.start { result in
switch result {
case .success(let credentials):
self.user = User(from: credentials.idToken)
case .failure(let error):
print("Failed with: \(error)")
}
}
}
func logout() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link logout URL on iOS 17.4+ / macOS 14.4+
.clearSession { result in
switch result {
case .success:
self.user = nil
case .failure(let error):
print("Failed with: \(error)")
}
}
}
}
```
```xml Auth0.plist lines theme={null}
ClientIdmz9iNEIo2PHu7oeh8QRt19ndTyyCIgaiDomaindev-gja8kxz4ndtex3rq.us.auth0.com
```
```swift ProfileView.swift lines theme={null}
```
```swift User.swift lines highlight={11-14} theme={null}
import JWTDecode
struct User {
let id: String
let email: String
let picture: String
}
extension User {
init?(from idToken: String) {
guard let jwt = try? decode(jwt: idToken),
let id = jwt.subject,
let email = jwt["email"].string,
let picture = jwt["picture"].string
else { return nil }
self.id = id
self.email = email
self.picture = picture
}
}
```
```swift MainView.swift lines highlight={34-45} theme={null}
import SwiftUI
import Auth0
struct MainView: View {
@State var user: User?
var body: some View {
if let user = self.user {
VStack {
ProfileView(user: user)
Button("Logout", action: self.logout)
}
} else {
Button("Login", action: self.login)
}
}
}
extension MainView {
func login() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link callback URL on iOS 17.4+ / macOS 14.4+
.start { result in
switch result {
case .success(let credentials):
self.user = User(from: credentials.idToken)
case .failure(let error):
print("Failed with: \(error)")
}
}
}
func logout() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link logout URL on iOS 17.4+ / macOS 14.4+
.clearSession { result in
switch result {
case .success:
self.user = nil
case .failure(let error):
print("Failed with: \(error)")
}
}
}
}
```
```xml Auth0.plist lines theme={null}
ClientIdmz9iNEIo2PHu7oeh8QRt19ndTyyCIgaiDomaindev-gja8kxz4ndtex3rq.us.auth0.com
```
```swift ProfileView.swift lines theme={null}
```
```swift User.swift lines highlight={11-14} theme={null}
import JWTDecode
struct User {
let id: String
let email: String
let picture: String
}
extension User {
init?(from idToken: String) {
guard let jwt = try? decode(jwt: idToken),
let id = jwt.subject,
let email = jwt["email"].string,
let picture = jwt["picture"].string
else { return nil }
self.id = id
self.email = email
self.picture = picture
}
}
```
```swift User.swift lines highlight={11-14} theme={null}
import JWTDecode
struct User {
let id: String
let email: String
let picture: String
}
extension User {
init?(from idToken: String) {
guard let jwt = try? decode(jwt: idToken),
let id = jwt.subject,
let email = jwt["email"].string,
let picture = jwt["picture"].string
else { return nil }
self.id = id
self.email = email
self.picture = picture
}
}
```
```xml Auth0.plist lines theme={null}
ClientIdmz9iNEIo2PHu7oeh8QRt19ndTyyCIgaiDomaindev-gja8kxz4ndtex3rq.us.auth0.com
```
```swift MainView.swift lines highlight={20-31} theme={null}
import SwiftUI
import Auth0
struct MainView: View {
@State var user: User?
var body: some View {
if let user = self.user {
VStack {
ProfileView(user: user)
Button("Logout", action: self.logout)
}
} else {
Button("Login", action: self.login)
}
}
}
extension MainView {
func login() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link callback URL on iOS 17.4+ / macOS 14.4+
.start { result in
switch result {
case .success(let credentials):
self.user = User(from: credentials.idToken)
case .failure(let error):
print("Failed with: \(error)")
}
}
}
func logout() {
Auth0
.webAuth()
.useHTTPS() // Use a Universal Link logout URL on iOS 17.4+ / macOS 14.4+
.clearSession { result in
switch result {
case .success:
self.user = nil
case .failure(let error):
print("Failed with: \(error)")
}
}
}
}
```
```swift ProfileView.swift lines theme={null}
```
Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.
This will add your app to your Auth0 tenant's `apple-app-site-association` file.
#### Add the associated domain capability
In Xcode, go to the **Signing and Capabilities** [tab](https://developer.apple.com/documentation/xcode/adding-capabilities-to-your-app#Add-a-capability) of your app's target settings, and press the **+
Capability** button. Then select **Associated Domains**.
Next, add the following [entry](https://developer.apple.com/documentation/xcode/configuring-an-associated-domain#Define-a-service-and-its-associated-domain) under **Associated Domains**:
```
webcredentials:labs-fundtraining.us.auth0.com
```
If you have a custom domain, use this instead of your
Auth0 tenant’s domain.
