TGFFido2AuthenticatorInfo

Objective-C


@interface TGFFido2AuthenticatorInfo : NSObject

Swift

class TGFFido2AuthenticatorInfo : NSObject

Information about an authenticator that helps a user decide which authenticator to select for an FIDO2 request that matches multiple authenticators.

@since 1.0.0

  • Initializes an instance of TGFFido2AuthenticatorInfo with details about a specific authenticator.

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithAuthenticatorId:
                             (NSString *_Nonnull)authenticatorId
                                            name:(NSString *_Nonnull)name
                                            icon:(NSData *_Nullable)icon
                                    verifyMethod:(TGFVerifyMethod)method;

    Swift

    init(authenticatorId: String, name: String, icon: Data?, verifyMethod method: TGFVerifyMethod)

    Parameters

    authenticatorId

    The AAGUID (Authenticator Attestation Globally Unique Identifier) of the authenticator.
    name

    The descriptive name of the authenticator.
    icon

    An NSData representation of the authenticator image icon.
    method

    The user verification method supported by the authenticator.

    Return Value

    An initialized TGFFido2AuthenticatorInfo object.

  • The authenticator’s unique identifier (AAGUID) that can be used to look up authenticator metadata from the FIDO Alliance Metadata Service (MDS).

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull authenticatorId;

    Swift

    var authenticatorId: String { get }

  • The descriptive name of the authenticator.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull name;

    Swift

    var name: String { get }

  • The authenticator’s icon, encoded in PNG format. This can optionally be displayed when asking the user to select an authenticator to use for this operation.

    Declaration

    Objective-C

    @property (readonly) NSData *_Nullable icon;

    Swift

    var icon: Data? { get }

  • The user verification method supported by the authenticator.

    Declaration

    Objective-C

    @property (readonly) TGFVerifyMethod verifyMethod;

    Swift

    var verifyMethod: TGFVerifyMethod { get }