Lock.swift : options de configuration

Options de configuration du comportement offertes avec Lock.Swift

Vous trouverez ci-dessous de nombreuses options pour configurer le comportement de Lock. De plus, la page Options de personnalisation du style propose aussi plusieurs options pour modifier l’apparence et le style de Lock.

Configurer le comportement de Lock

Vous pouvez ajouter des options de configuration à l’initialisation de votre Lock à l’aide de withOptions.

Lock
  .classic()
  .withOptions {
    $0.closable = true
    $0.usernameStyle = [.Username]
    $0.allow = [.Login, .ResetPassword]
  }
  .present(from: self)

Options de comportement

closable

Permet à l’utilisateur de supprimer Lock. Par défaut, cette valeur est false.

.withOptions {
  $0.closable = true
}

scope

Portée utilisée pour l’authentification. Par défaut, la valeur est openid. Elle renvoie non seulement le jeton d’accès, mais aussi un jeton d’identité, qui est un JSON Web Token (JWT) contenant des renseignements sur l’utilisateur. Consultez la documentation sur les portées pour en savoir plus sur les portées d’authentification.

.withOptions {
  $0.scope = "openid name email picture"
}

Jetons d’actualisation

Le fait de préciser la portée offline_access dans vos options Lock permettra de renvoyer un jeton d’actualisation avec l’access_token et l’id_token. Les jetons d’actualisation peuvent être enregistrés et utilisés pour obtenir un nouveau jeton d’accès lorsque l’ancien expire. Pour en savoir plus sur l’utilisation des jetons d’actualisation avec l’authentification Auth0, consultez la documentation de référence du SDK Auth0.Swift, que vous utiliseriez pour mettre en œuvre les jetons d’actualisation, ou le guide Quickstart Swift, qui fournit un exemple complet de l’utilisation d’Auth0 dans le développement Swift, y compris la gestion des jetons d’actualisation.

termsOfService

Par défaut, Lock utilisera les Conditions d’utilisation et la Politique de confidentialité d’Auth0, mais il est possible de renseigner d’autres URL pour créer des liens vers d’autres conditions et politiques.

.withOptions {
  $0.termsOfService = "https://mycompany.com/terms"
  $0.privacyPolicy = "https://mycompany.com/privacy"
}

Afficher les conditions d’utilisation

Les connexions de base de données affichent la boîte de dialogue des conditions d’utilisation. La valeur par défaut est true. Notez que les conditions d’utilisation seront toujours affichées si l’indicateur mustAcceptTerms est activé.

.withOptions {
    $0.showTerms = true
}

Exiger que les utilisateurs acceptent les Conditions d’utilisation

Les connexions de base de données nécessitent l’acceptation explicite des Conditions d’utilisation.

.withOptions {
    $0.mustAcceptTerms = true
}

Options de Web Authentication

leeway

Tolérance de décalage d’horloge utilisée pour la validation du jeton d’identité. Elle élargit la période pendant laquelle le jeton d’identité est encore considéré comme valide, afin de tenir compte de l’écart entre l’heure du serveur et celle du client. Par défaut, elle est de 60000 millisecondes (60 secondes).

.withOptions {
  $0.leeway = 30000 // 30 secondes
}

maxAge

Temps écoulé maximal autorisé (en millisecondes) depuis la dernière authentification de l’utilisateur. Utilisé pour valider le jeton d’identité. S’il est défini, le jeton d’identité contiendra une revendication auth_time avec l’horodatage de l’authentification. La valeur par défaut est nil.

.withOptions {
  $0.maxAge = 86400000 // 1 jour
}

Options de la connexion base de données

allow

Quels écrans seront accessibles ; par défaut, tous les écrans sont activés, notamment .Login, .Signup, .ResetPassword.

.withOptions {
  $0.allow = [.Login, .ResetPassword]
}

initialScreen

Le premier écran à afficher à l’utilisateur. Par défaut, il s’agit de .Login; les autres options sont .Signup et ResetPassword.

.withOptions {
  $0.initialScreen = .Login
}

usernameStyle

Précisez le type d’identifiant exigé pour la connexion. Par défaut, il peut s’agir de l’un ou l’autre des éléments suivants : [.Username, .Email], mais cette option peut aussi accepter [.Username] ou [.Email]. Cependant, il est important de noter que cette option n’est active que si vous avez défini l’indicateur requires_username à true dans votre Auth0 Dashboard.

.withOptions {
  $0.usernameStyle = [.Username]
}

Champs d’inscription personnalisés

Par défaut, l’inscription exige l’adresse courriel et le mot de passe de l’utilisateur. Vous pouvez ajouter d’autres champs selon vos besoins en matière de collecte de données. Les champs d’inscription supplémentaires ajoutés ici seront stockés dans le user_metadata. Pour en savoir plus, consultez Metadata. Notez que vous devez préciser l’icône à utiliser avec votre champ de texte personnalisé.

.withOptions {
  $0.customSignupFields = [
    CustomTextField(name: "first_name", placeholder: "First Name", icon: LazyImage(name: "ic_person", bundle: Lock.bundle)),
    CustomTextField(name: "last_name", placeholder: "Last Name", icon: LazyImage(name: "ic_person", bundle: Lock.bundle))
  ]
}

Vous pouvez aussi indiquer des icônes provenant d’autres bundles, comme dans l’exemple suivant : CustomTextField(name: “slack_handle”, placeholder: “Nom d’utilisateur Slack”, icon: LazyImage(name: “ic_slack”, bundle: Bundle(identifier: “CustomBundle”)))

Options d’entreprise

Il existe aussi des options de configuration propres aux connexions d’entreprise :

enterpriseConnectionUsingActiveAuth

Par défaut, les connexions d’entreprise utilisent Web Authentication. Cependant, vous pouvez préciser quelles connexions utiliseront plutôt l’authentification par identifiants et demanderont un nom d’utilisateur et un mot de passe.

.withOptions {
  $0.enterpriseConnectionUsingActiveAuth = ["enterprisedomain.com"]
}

activeDirectoryEmailAsUsername

En mode d’authentification par identifiants, l’utilisateur doit-il fournir son adresse courriel comme identifiant? Par défaut, la valeur est false et c’est plutôt un nom d’utilisateur qui est requis.

.withOptions {
  $0.activeDirectoryEmailAsUsername = true
}

Options de journalisation

Lock offre des options pour activer et désactiver facilement les fonctionnalités de journalisation, ainsi que pour ajuster d’autres paramètres connexes.

logLevel

Par défaut, cette valeur est .off et les niveaux de journalisation Syslog sont pris en charge.

.withOptions {
  $0.logLevel = .all
}

logHttpRequest

Indique s’il faut consigner les requêtes de l’API Auth0.swift. Par défaut, cette valeur est false.

.withOptions {
  $0.logHttpRequest = true
}

loggerOutput

Indiquez le gestionnaire de sortie du journaliseur; par défaut, cette option utilise l’instruction print.

.withOptions {
  $0.loggerOutput = CleanroomLockLogger()
}

Dans le code ci-dessus, loggerOutput a été configuré pour utiliser CleanroomLogger. On peut généralement y arriver en implémentant le protocole loggerOutput. Vous pouvez bien sûr utiliser votre bibliothèque de journalisation préférée. Vous trouverez ci-dessous un exemple montrant comment gérer la sortie de loggerOutput avec CleanroomLogger.

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)
  }
}