TGFFido2AuthenticatorRegistrationInfo

Objective-C


@interface TGFFido2AuthenticatorRegistrationInfo : TGFFido2AuthenticatorInfo

Swift

class TGFFido2AuthenticatorRegistrationInfo : TGFFido2AuthenticatorInfo

Encapsulates information about a registered FIDO2 authenticator.

@since 1.0.0

  • Initializes an instance of TGFFido2AuthenticatorRegistrationInfo with detailed information about a specific authenticator registration.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithAuthenticatorId:(NSString *_Nonnull)authenticatorId
                       name:(NSString *_Nonnull)name
                       icon:(NSData *_Nullable)icon
               credentialId:(NSMutableData *_Nullable)credentialId
                   rpIdHash:(NSMutableData *_Nullable)rpIdHash
                     userId:(NSString *_Nullable)userId
               verifyMethod:(TGFVerifyMethod)method
                   userName:(NSString *_Nullable)userName
            userDisplayName:(NSString *_Nullable)userDisplayName
                       rpId:(NSString *_Nullable)rpId
               creationDate:(nonnull NSDate *)creationDate
               lastUsedDate:(NSDate *_Nullable)lastUsedDate;

    Swift

    init(authenticatorId: String, name: String, icon: Data?, credentialId: NSMutableData?, rpIdHash: NSMutableData?, userId: String?, verifyMethod method: TGFVerifyMethod, userName: String?, userDisplayName: String?, rpId: String?, creationDate: Date, lastUsedDate: Date?)

    Parameters

    authenticatorId

    The ID of the authenticator (AAGUID).
    name

    The name of the authenticator.
    icon

    An NSData representation of the authenticator image icon.
    credentialId

    The credentialId of a registered authenticator.
    rpIdHash

    A hash of the rpId for the registered authenticator.
    userId

    The userId of the registered authenticator.
    method

    The user verification method supported by the authenticator.
    userName

    The username of the registered Authenticator.
    userDisplayName

    The user display name for the registered Authenticator.
    rpId

    The rpId for the registered authenticator.
    creationDate

    The creation time for the registered authenticator.
    lastUsedDate

    The last used time for the registered authenticator.

    Return Value

    An initialized TGFFido2AuthenticatorRegistrationInfo object.

  • The corresponding credentialId tying to a specific registration

    Declaration

    Objective-C

    @property (readonly) NSMutableData *_Nullable credentialId;

    Swift

    var credentialId: NSMutableData? { get }

  • The corresponding rpIdHash tying to a specific registration

    Declaration

    Objective-C

    @property (readonly) NSMutableData *_Nullable rpIdHash;

    Swift

    var rpIdHash: NSMutableData? { get }

  • The corresponding userId tying to a specific registration

    @since 1.6.0

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable userId;

    Swift

    var userId: String? { get }

  • The corresponding userName tying to a specific registration

    @since 4.0.0

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable userName;

    Swift

    var userName: String? { get }

  • The corresponding user display name tying to a specific registration

    @since 4.0.0

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable userDisplayName;

    Swift

    var userDisplayName: String? { get }

  • The corresponding rpId tying to a specific registration

    @since 4.0.0

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable rpId;

    Swift

    var rpId: String? { get }

  • The date and time when this authenticator was created.

    @since 4.0.0

    Declaration

    Objective-C

    @property (readonly) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get }

  • The date and time when this authenticator was last used. This value is updated each time the authenticator successfully completes an authentication operation.

    @since 4.0.0

    Declaration

    Objective-C

    @property (readonly) NSDate *_Nullable lastUsedDate;

    Swift

    var lastUsedDate: Date? { get }

  • Wipes all sensitive data

    Declaration

    Objective-C

    - (void)wipe;

    Swift

    func wipe()