AuthenticatorInformation
public struct AuthenticatorInformation
Provides information about an Authenticator.
-
The “Authenticator Attestation ID” (AAID), which identifies the type and batch of the authenticator.
Declaration
Swift
public let aaid: String
-
A short localized title for the authenticator in the current locale.
Declaration
Swift
public let title: String
-
A localized long description of what the authenticator represents in the current locale.
Declaration
Swift
public let description: String
-
Returns
true
if the device has hardware supporting this authenticator, false otherwise.Declaration
Swift
public let isSupportedByHardware: Bool
-
Returns
true
if the Authenticator has enrollment capabilities and it is enrolled, or if the Authenticator has no enrollment capabilities, false otherwise.Declaration
Swift
@available(*, deprecated, message: "Please use `userEnrollment` instead.") public let isUserEnrolled: Bool
-
Returns
true
if the user has a registered with this Authenticator, false otherwise.Declaration
Swift
@available(*, deprecated, message: "Please use `registration` instead.") public let isRegistered: Bool
-
The list of supported setting operations for the authenticator.
Declaration
Swift
@available(*, deprecated, message: "Please use `supportedOpenSettingsOperations(for username: Username﹚` instead.") public let supportedOpenSettingsOperations: [OpenSettingsOperation]
-
Returns the user enrollment information. If this is an OS based authenticator, the user is enrolled when fingerprints are defined at the operating system level. If the authenticator is managed at the SDK level, the credentials can be defined and modified using an open settings operation
Declaration
Swift
public let userEnrollment: UserEnrollment?
-
Returns the object containing the registration information for the current AuthenticatorInformation
Declaration
Swift
public let registration: Registration?
-
init(aaid:
title: description: isSupportedByHardware: isUserEnrolled: isRegistered: supportedOpenSettingsOperations: userEnrollment: registration: supportedOpenSettingsOperationsForUser: authenticatorIndex: ) ONLY FOR AUTOMATED TESTING PURPOSES; DO NOT USE IN PRODUCTION CODE **
Declaration
Swift
public init(aaid: String, title: String, description: String, isSupportedByHardware: Bool, isUserEnrolled: Bool, isRegistered: Bool, supportedOpenSettingsOperations: [OpenSettingsOperation], userEnrollment: UserEnrollment?, registration: Registration?, supportedOpenSettingsOperationsForUser: [String? : [OpenSettingsOperation]], authenticatorIndex: Int)
-
Returns the list of available setting operations, which can be performed by the given user.
Declaration
Swift
func supportedOpenSettingsOperations(for username: Username) -> [OpenSettingsOperation]