Class Configuration`Abstract`

The MobileAuthenticationClient configuration.

The Configuration is used to build and initialize the MobileAuthenticationClient.

See

MobileAuthenticationClientInitializer.configuration

Index

Methods

getBaseUrl getRegistrationRequestPath getRegistrationResponsePath getAuthenticationRequestPath getAuthenticationResponsePath getDeregistrationRequestPath getDispatchTargetResourcePath getDeviceResourcePath getNetworkTimeoutInSeconds getUserInteractionTimeoutInSeconds getAppAttestation builder authCloudBuilder admin4PatternBuilder

Methods

`Abstract`getBaseUrl

getBaseUrl(): string
The default base URL for the HTTP endpoints the SDK must interact with.

Returns string
the base URL.

`Abstract`getRegistrationRequestPath

getRegistrationRequestPath(): string
The registration request URL path used to send the FIDO UAF registration GetUafRequest.

The registration request URL is the result of combining the baseUrl and this path.

Returns string
the registration request path.

`Abstract`getRegistrationResponsePath

getRegistrationResponsePath(): string
The registration response URL path used to send the final FIDO UAF registration response.

The registration response URL is the result of combining the baseUrl and this path.

Returns string
registration response path.

`Abstract`getAuthenticationRequestPath

getAuthenticationRequestPath(): string
The authentication request URL path used to send the FIDO UAF authentication GetUafRequest.

The authentication request URL is the result of combining the baseUrl and this path.

Returns string
the authentication request path.

`Abstract`getAuthenticationResponsePath

getAuthenticationResponsePath(): string
The authentication response URL path used to send the final FIDO UAF authentication response.

The authentication response URL is the result of combining the baseUrl and this path.

Returns string
the authentication response path.

`Abstract`getDeregistrationRequestPath

getDeregistrationRequestPath(): string
Returns the URL path used to obtain the FIDO UAF deregistration request.

The deregistration request URL is the result of combining the baseUrl and this path.

Returns string
the deregistration request path.

`Abstract`getDispatchTargetResourcePath

getDispatchTargetResourcePath(): string
The dispatch target resource URL path.

The dispatch target resource URL is the result of combining the baseUrl and this path.

Returns string
the dispatch target resource path.

`Abstract`getDeviceResourcePath

getDeviceResourcePath(): string
The device managing resource URL path.

The device managing resource URL is the result of combining the baseUrl and this path.

Returns string
the device managing resource path.

`Abstract`getNetworkTimeoutInSeconds

getNetworkTimeoutInSeconds(): number
Time interval for network calls in seconds. Any network request that takes longer than this value, will result in a timeout.

Returns number
the time interval for network requests.

`Abstract`getUserInteractionTimeoutInSeconds

getUserInteractionTimeoutInSeconds(): number
The user interaction timeout in seconds. This is the maximum time that the SDK will wait to obtain a result when AccountSelector.selectAccount, AuthenticatorSelector.selectAuthenticator, PinUserVerifier.verifyPin, PasswordUserVerifier.verifyPassword, FingerprintUserVerifier.verifyFingerprint, or BiometricUserVerifier.verifyBiometric are invoked (i.e. the maximum time to wait before any of the methods of the provided consumer in any of those methods is invoked).

If the timeout occurs, then the operation delegate failure method (Registration.onError, OutOfBandRegistration.onError, Authentication.onError or OutOfBandAuthentication.onError, depending on the operation being executed) will be invoked. The provided exception will contain an FidoErrorCodeType.UserNotResponsive error code.

Returns number
the timeout for user interaction.

`Abstract`getAppAttestation

getAppAttestation(): undefined | AppAttestation
The configuration related to application attestation.

If the backend (nevisFIDO) requires application attestation through its policy, you must provide this information, so that the mobile SDK can send the required application attestation information.

This information is not needed if your backend does not require application attestation.

Returns undefined | AppAttestation

`Static`builder

builder(): ConfigurationBuilder
Returns a new ConfigurationBuilder.

Returns ConfigurationBuilder
a new ConfigurationBuilder.

`Static`authCloudBuilder

authCloudBuilder(): ConfigurationAuthCloudBuilder
Returns a new ConfigurationAuthCloudBuilder. This is a simpler version of ConfigurationBuilder that can only be used when your application interacts with the Nevis Authentication Cloud.

If you are fine with the default network parameters of the builder, you just need to provide the hostname of your application to build a Configuration object:

Returns ConfigurationAuthCloudBuilder
a new ConfigurationAuthCloudBuilder.
Example
```
const configuration = Configuration.authCloudBuilder()
    .hostname(hostname)
    .build();
```

`Static`admin4PatternBuilder

admin4PatternBuilder(): ConfigurationAdmin4PatternBuilder
Returns a new ConfigurationAdmin4PatternBuilder. This is a simpler version of ConfigurationBuilder that can only be used when your application interacts with the Nevis Identity Suite configured with default Nevis Admin 4 pattern.

If you are fine with the default network parameters of the builder, you just need to provide the hostname of your application to build a Configuration object:

Returns ConfigurationAdmin4PatternBuilder
a new ConfigurationAdmin4PatternBuilder.
Example
```
const configuration = Configuration.admin4PatternBuilder()
    .hostname(hostname)
    .build();
```

Class Configuration`Abstract`

See

Index

Methods

Methods

`Abstract`getBaseUrl

Returns string

`Abstract`getRegistrationRequestPath

Returns string

`Abstract`getRegistrationResponsePath

Returns string

`Abstract`getAuthenticationRequestPath

Returns string

`Abstract`getAuthenticationResponsePath

Returns string

`Abstract`getDeregistrationRequestPath

Returns string

`Abstract`getDispatchTargetResourcePath

Returns string

`Abstract`getDeviceResourcePath

Returns string

`Abstract`getNetworkTimeoutInSeconds

Returns number

`Abstract`getUserInteractionTimeoutInSeconds

Returns number

`Abstract`getAppAttestation

Returns undefined | AppAttestation

`Static`builder

Returns ConfigurationBuilder

`Static`authCloudBuilder

Returns ConfigurationAuthCloudBuilder

Example

`Static`admin4PatternBuilder

Returns ConfigurationAdmin4PatternBuilder

Example

Settings

On This Page

Class ConfigurationAbstract

See

Index

Methods

Methods

AbstractgetBaseUrl

Returns string

AbstractgetRegistrationRequestPath

Returns string

AbstractgetRegistrationResponsePath

Returns string

AbstractgetAuthenticationRequestPath

Returns string

AbstractgetAuthenticationResponsePath

Returns string

AbstractgetDeregistrationRequestPath

Returns string

AbstractgetDispatchTargetResourcePath

Returns string

AbstractgetDeviceResourcePath

Returns string

AbstractgetNetworkTimeoutInSeconds

Returns number

AbstractgetUserInteractionTimeoutInSeconds

Returns number

AbstractgetAppAttestation

Returns undefined | AppAttestation

Staticbuilder

Returns ConfigurationBuilder

StaticauthCloudBuilder

Returns ConfigurationAuthCloudBuilder

Example

Staticadmin4PatternBuilder

Returns ConfigurationAdmin4PatternBuilder

Example

Settings

On This Page

Class Configuration`Abstract`

`Abstract`getBaseUrl

`Abstract`getRegistrationRequestPath

`Abstract`getRegistrationResponsePath

`Abstract`getAuthenticationRequestPath

`Abstract`getAuthenticationResponsePath

`Abstract`getDeregistrationRequestPath

`Abstract`getDispatchTargetResourcePath

`Abstract`getDeviceResourcePath

`Abstract`getNetworkTimeoutInSeconds

`Abstract`getUserInteractionTimeoutInSeconds

`Abstract`getAppAttestation

`Static`builder

`Static`authCloudBuilder

`Static`admin4PatternBuilder