Configuration

struct Configuration : Codable

A configuration object that defines behavior and policies for a NEVIS Authentication session.

  • The base URL to communicate with the NEVIS Mobile Authentication backend.

    Declaration

    Swift

    public let baseURL: URL
  • The endpoint used for the FIDO Registration Request service.

    Declaration

    Swift

    public let registrationRequestPath: String
  • The endpoint used for the FIDO Registration Response service.

    Declaration

    Swift

    public let registrationResponsePath: String
  • The endpoint used for the FIDO Deregistration Request service.

    Declaration

    Swift

    public let deregistrationRequestPath: String
  • The endpoint used for the FIDO Authentication Request service.

    Declaration

    Swift

    public let authenticationRequestPath: String
  • The endpoint used for the FIDO Authentication Response service.

    Declaration

    Swift

    public let authenticationResponsePath: String
  • The maximum number of retries for FIDO Authentication while accessing a protected resource.

    Declaration

    Swift

    public let authenticationMaxRetries: Int
  • The interval (in seconds) between retries for FIDO Authentication.

    Declaration

    Swift

    public let authenticationRetryIntervalInSeconds: TimeInterval
  • The endpoint used for creating, updating and deleting a dispatch target.

    Declaration

    Swift

    public let dispatchTargetResourcePath: String
  • The policy describing the pinning.

    Declaration

    Swift

    public let pinningPolicy: NevisServerPinningPolicy
  • The timeout interval (in seconds) for waiting an HTTP request to be finished.

    Declaration

    Swift

    public let timeoutIntervalForNetworkRequestInSeconds: TimeInterval
  • The maximum time in seconds that the SDK waits for user interaction.

    Declaration

    Swift

    public let userInteractionTimeoutInSeconds: TimeInterval
  • Creates a new configuration object.

    Declaration

    Swift

    public init(
    	baseURL: URL,
    	registrationRequestPath: String,
    	registrationResponsePath: String,
    	deregistrationRequestPath: String,
    	authenticationRequestPath: String,
    	authenticationResponsePath: String,
    	authenticationMaxRetries: Int = 3,
    	authenticationRetryIntervalInSeconds: TimeInterval = 1.0,
    	dispatchTargetResourcePath: String,
    	pinningPolicy: NevisServerPinningPolicy,
    	timeoutIntervalForNetworkRequestInSeconds: TimeInterval = 60.0,
    	userInteractionTimeoutInSeconds: TimeInterval = 240.0
    )

    Parameters

    baseURL

    The base URL to communicate with the NEVIS Mobile Authentication backend.

    registrationRequestPath

    The endpoint used for the FIDO Registration Request service.

    registrationResponsePath

    The endpoint used for the FIDO Registration Response service.

    authenticationRequestPath

    The endpoint used for the FIDO Deregistration Request service.

    authenticationResponsePath

    The endpoint used for the FIDO Authentication Response service.

    authenticationMaxRetries

    The maximum number of retries for FIDO Authentication while accessing a protected resource. Default is 3.

    authenticationRetryIntervalInSeconds

    The interval (in seconds) between retries for FIDO Authentication. Default is 1 second.

    dispatchTargetResourcePath

    The endpoint used for creating, updating and deleting a dispatch target.

    pinningPolicy

    The policy describing the pinning.

    timeoutIntervalForNetworkRequestInSeconds

    The timeout interval (in seconds) for waiting an HTTP request to be finished. Default is 60 seconds.

    userInteractionTimeoutInSeconds

    The maximum time in seconds that the SDK waits for user interaction.