Factor

public protocol Factor

Describes the information of a Factor.

  • Status of the Factor.

    Declaration

    Swift

    var status: FactorStatus { get set }
  • sid

    The unique SID identifier of the Factor.

    Declaration

    Swift

    var sid: String { get }

  • A human readable description of this resource, up to 64 characters. For a push factor, this can be the device’s name.

    Declaration

    Swift

    var friendlyName: String { get }

  • The unique SID of the Account that created the Service resource.

    Declaration

    Swift

    var accountSid: String { get }

  • The unique SID identifier of the Service to which the Factor is related.

    Declaration

    Swift

    var serviceSid: String { get }

  • Identifies the user, should be an UUID you should not use PII (Personal Identifiable Information) because the systems that will process this attribute assume it is not directly identifying information.

    Declaration

    Swift

    var identity: String { get }

  • Type of the Factor. Currently only push is supported.

    Declaration

    Swift

    var type: FactorType { get }

  • Indicates the creation date of the Factor.

    Declaration

    Swift

    var createdAt: Date { get }

  • Custom metadata associated with the factor when created. This is added by the Device/SDK directly to allow for the inclusion of device information.

    Declaration

    Swift

    var metadata: [String : String]? { get }