Lock Classic handles authentication using Database, Social, and Enterprise connections.
It is strongly encouraged that this SDK be used in OIDC Conformant mode. When this mode is enabled, it will force the SDK to use Auth0's current authentication pipeline and will prevent it from reaching legacy endpoints. Defaults to false.
.withOptions {
$0.oidcConformant = true
}For more information, please see the OIDC adoption guide.
To show Lock, add the following snippet in your UIViewController:
Lock
.classic()
.withOptions {
$0.closable = false
$0.oidcConformant = true
}
.withStyle {
$0.title = "Welcome to my App!"
}
.onAuth {
print("Obtained credentials \($0)")
}
.onError {
print("Failed with \($0)")
}
.onCancel {
print("User cancelled")
}
.present(from: self)If you are using a Database connection in Lock then you will need to enable the Password Grant Type, please follow the Update Grant Types guide.
Lock will automatically load your application configuration automatically, if you wish to override this behaviour you can manually specify which of your connections to use.
Before presenting Lock you can tell it what connections it should display and use to authenticate an user. You can do that by calling the method and supply a closure that can specify the connections.
.withConnections {
$0.database(name: "Username-Password-Authentication", requiresUsername: true)
}.withConnections { connections in
connections.social(name: "google-oauth2", style: .Google)
connections.social(name: "github", style: .Github)
}.withConnections { connections in
connections.enterprise(name: "customAD", domains: ["domain1.com", "domain2.com"])
connections.enterprise(name: "alternativeAD", domains: ["domain3.com"], style: .Microsoft)
}If you are using Custom Domains, you will need to set the configurationBaseURL to your Auth0 Domain so the Lock configuration can
be read correctly:
.withOptions {
$0.configurationBase = "https://YOUR_DOMAIN.auth0.com"
}You can easily turn on/off logging capabilities:
Lock
.classic()
.withOptions {
$0.logLevel = .all
$0.logHttpRequest = true
}Lock Passwordless handles authentication using Passwordless and Social connections.
💡 The Passwordless feature requires your application to have the Passwordless OTP Grant Type enabled. Check this article for more information.
To use Passwordless Authentication with Lock, you need to configure it with OIDC Conformant Mode set to true.
💡 OIDC Conformant Mode will force Lock to use Auth0's current authentication pipeline and will prevent it from reaching legacy endpoints. By default this mode is disabled. For more information, please see the OIDC adoption guide.
To show Lock, add the following snippet in your UIViewController:
Lock
.passwordless()
.withOptions {
$0.oidcConformant = true
}
.withStyle {
$0.title = "Welcome to my App!"
}
.onAuth {
print("Obtained credentials \($0)")
}
.onError {
print("Failed with \($0)")
}
.onCancel {
print("User cancelled")
}
.onPasswordless {
print("Passwordless requested for \($0)")
}
.present(from: self)
⚠️ Passwordless can only be used with a single connection and will prioritize the use of email connections over sms.
When using Lock Passwordless the default passwordlessMethod is .code which sends the user a one time passcode to login. If you want to use Universal Links you can add the following:
.withOptions {
$0.passwordlessMethod = .magicLink
}If you are using Lock Passwordless and have specified the .magicLink option to send the user a universal link then you will need to add the following to your AppDelegate.swift:
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
return Lock.continueAuth(using: userActivity)
}.withConnections {
$0.sms(name: "sms")
}.withConnections {
$0.email(name: "email")
}Lock.swift provides many styling options to help you apply your own brand identity to Lock.
iPad presentation is show in a modal popup, this can be disabled to use full screen as follows:
.withStyle {
$0.modalPopup = false
}.withStyle {
$0.title = "Company LLC"
$0.logo = UIImage(named: "company_logo")
$0.primaryColor = UIColor(red: 0.6784, green: 0.5412, blue: 0.7333, alpha: 1.0)
}💡 You can explore the full range of styling options in Style.swift.
.withStyle {
$0.oauth2["slack"] = AuthStyle(
name: "Slack",
color: UIColor(red: 0.4118, green: 0.8078, blue: 0.6588, alpha: 1.0),
withImage: UIImage(named: "ic_slack")
)
}Lock.swift provides numerous options to customize the Lock experience.
Allows Lock to be dismissed by the user. Defaults to false.
.withOptions {
$0.closable = true
}By default Lock will use Auth0's Terms of Service and Privacy Policy:
.withOptions {
$0.termsOfService = "https://example.com/terms"
$0.privacyPolicy = "https://example.com/privacy"
}Database connection will require explicit acceptance of Terms of Service:
.withOptions {
$0.mustAcceptTerms = true
}Database connection will display the Terms of Service dialog. Defaults to true.
.withOptions {
$0.showTerms = true
}
⚠️ Terms will always be shown if themustAcceptTermsflag has been enabled.
- logLevel: Defaults to
.off. Syslog logging levels are supported. - logHttpRequest: Log Auth0.swift API requests. Defaults to
false. - loggerOutput: Specify output handler, by default this uses the
printstatement.
.withOptions {
$0.logLevel = .all
$0.logHttpRequest = true
$0.loggerOutput = CleanroomLockLogger()
}In the code above, the loggerOutput has been set to use CleanroomLogger. This can typically be achieved by implementing the loggerOutput protocol. You can of course use your favorite logger library.
class CleanroomLockLogger: LoggerOutput {
func message(_ message: String, level: LoggerLevel, filename: String, line: Int) {
let channel: LogChannel?
switch level {
case .debug:
channel = Log.debug
case .error:
channel = Log.error
case .info:
channel = Log.info
case .verbose:
channel = Log.verbose
case .warn:
channel = Log.warning
default:
channel = nil
}
channel?.message(message, filePath: filename, fileLine: line)
}
}Scope used for authentication. By default is openid. It will return not only the access_token, but also an id_token which is a JSON Web Token (JWT) containing user information.
.withOptions {
$0.scope = "openid profile email offline_access"
}Allows you to set provider scopes for OAuth2/Social connections with a comma separated list. By default is empty.
.withOptions {
$0.connectionScope = ["github": "public_repo read:user"]- allow: Which database screens will be accessible, the default is enable all screens e.g.
.Login, .Signup, .ResetPassword - initialScreen: The first screen to present to the user, the default is
.login. - usernameStyle: Specify the type of identifier the login will require. The default is either
[.Username, .Email]. However it's important to note that this option is only active if you have set the requires_username flag totruein your Auth0 Dashboard
.withOptions {
$0.allow = [.Login, .ResetPassword]
$0.initialScreen = .login
$0.usernameStyle = [.Username]
}When signing up the default information requirements are the user's email and password. You can expand your data capture requirements as needed.
If you want to save the value of the attribute in the root of a user's profile, ensure you set the storage parameter to .rootAttribute. Only a subset of values can be stored this way. The list of attributes that can be added to your root profile is here. By default, every additional sign up field is stored inside the user's user_metadata object.
When signing up, your app may need to assign values to the user's profile that are not entered by the user. The hidden property of CustomTextField prevents the signup field from being shown to the user, allowing your app to assign default values to the user profile.
.withOptions {
$0.customSignupFields = [
CustomTextField(name: "first_name", placeholder: "First Name", storage: .rootAttribute, icon: UIImage(named: "ic_person", bundle: Lock.bundle), contentType: .givenName),
CustomTextField(name: "last_name", placeholder: "Last Name", storage: .rootAttribute, icon: UIImage(named: "ic_person", bundle: Lock.bundle), contentType: .familyName),
CustomTextField(name: "referral_code", placeholder: "Referral Code", defaultValue: referralCode, hidden: true)
]
}
⚠️ You must specify the icon to use with your custom text field and store it in your App's bundle.
This functionality has been removed as of Release 2.18 due to the 1Password extension using deprecated methods, which can result in your app being rejected by the AppStore. This functionality was superseded in iOS 12 when Apple introduced the integration of password managers into login forms.
The following options are now deprecated:
.withOptions {
$0.passwordManager.enabled = false
$0.passwordManager.appIdentifier = "www.example.com"
$0.passwordManager.displayName = "My App"
}You may also safely remove the following entry from your app's Info.plist:
<key>LSApplicationQueriesSchemes</key>
<array>
<string>org-appextension-feature-password-management</string>
</array>By default a show password icon is shown in password fields to toggle visibility of the input text. You can disable this using the allowShowPassword option:
.withOptions {
$0.allowShowPassword = false
}
⚠️ Show password will not be available if the Password Manager is available.
- enterpriseConnectionUsingActiveAuth: By default Enterprise connections will use Web Authentication. However you can specify which connections will alternatively use credential authentication and prompt for a username and password.
- activeDirectoryEmailAsUsername: When Lock request your enterprise credentials after performing Home Realm Discovery (HRD), e.g. for Active Directory, it will try to prefill the username for you. By default it will parse the email's local part and use that as the username, e.g.
[email protected]will bejohn.doe. If you don't want that you can turn on this flag and it will just use the email address.
.withOptions {
$0.activeDirectoryEmailAsUsername = true
$0.enterpriseConnectionUsingActiveAuth = ["example.com"]
}