Utility app configuration

appSdkConfig

Optional: Specifies options for the AppSdkConfig object. For more details about those options, see the AppSdkConfig object in the ClientAPI docs for Nok Nok Web App SDK.

authOpts

Optional. Specifies authentication options in nnlsignin. For more information see the authOpts parameter of the AdaptiveUI.getAuthenticationView() function in the Client API docs for Nok Nok Web SDK.

fedAppConfig

Optional. A configuration object that specifies options for nnlfedapp. See table below for specific fields inside this object. These configurations override the defaults set in nnlfedapp/static/config/config.js.

fidoRegOpts

Optional. Specifies options when nnlfedapp registers FIDO authenticators. For more details see the Extras parameter of the AppSdk.getFidoRegistrationView() function in the Client API docs for Nok Nok Web App SDK.

manageRegOpts

Optional. Specifies options when nnlfedapp manages registrations. For more details see the Extras parameter of the AppSdk.getManageRegistrationsView() function in the Client API docs for Nok Nok Web SDK.

regOpts

Optional. Specifies options when nnlfedapp registers non-FIDO authentication methods. For more details see the regOpts parameter of the AdaptiveUI.getRegistrationView() function in the Client API docs for Nok Nok Web App SDK.

signinConfig

Optional. A configuration object that specifies options for nnlsignin. See table below for specific fields inside this object. These configurations override the defaults set in nnlsignin/config/config.js file.

suggestRegOpts

Optional. Specifies Suggest Registration options in nnlsignin. For more information see the suggestRegOpts parameter of the AdaptiveUI.getAuthenticationView() function in the Client API docs for Nok Nok Web SDK.

nnlappsdk_url

The URL where the Nok Nok Web App SDK is located. Default value is "${host}/nnlappsdk-${appsdk_version}"

reg_endpoint

The registration endpoint for the API Server. Default value is "${host}/nnlgateway/nnl/${tenant_id}/reg"

auth_endpoint

The authentication endpoint for the API Server. Default value is "${host}/nnlgateway/nnl/${tenant_id}/auth"

storage_endpoint

The endpoint of the cookie-based storage. The default value is "${host}/nnlgateway/storage"

ui_config_url

The URL of the root configuration directory for the JSON UI Configuration files used by nnlfedapp. Default value is null. See App UI Customization for details on how to create your UI Configuration files, and see the section Storing Your UI Configuration Files Using a Remote Server for information about how to structure the directories that contain your UI configuration.

auth_endpoint

The authentication endpoint for the API Server. Default value is "${host}/nnlgateway/nnl/${tenant_id}/auth"

auth_start_mode

The mode that authentication should start in. For available values see the AutoStart enum in the Web App SDK API Docs. The default value is "SIGN_IN".

cookie_domain

The domain of the authentication cookie that nnlsignin uses to pass the JWT of authenticated user to the Nok Nok Federation Adapter.

cookie_name

The name of the authentication cookie that nnlsignin uses to pass the JWT of an authenticated user to the Nok Nok Federation Adapter.

federation_resume_uri

Default value is null. The nnlsignin app can pass the JWT of an authenticated user to the Nok Nok Federation Adapter in 2 different ways:

1. Drop the JWT into the cookie and redirect to the Federation Server. In this case the nnlsignin app and the Federation Server are assumed to be on the same origin or share the same parent origin. In this case, signinConfig.federation_resume_uri parameter is not used and should be left with its default value.
2. Pass the JWT through the form-post request. The nnlsignin app and the Federation Server can be on completely different origins (cross-origin form-post) or share the same or parent origin. The signinConfig.federation_resume_uri specifies a base or full URL on the Federation Server to do a form-post after successful authentication at Nok Nok. The URL can be full or relative, e.g.:

signinConfig.federation_resume_uri = "${host}/path/to/fedserver";

or

signinConfig.federation_resume_uri = "/path/to/fedserver";

In some cases the signinConfig.federation_resume_uri is a base URI because a full form-post URL may contain the resume path which is not known yet. The Nok Nok Federation Adapter may provide the resume path to nnlsignin during the redirect. The nnlsignin app then concatenates the resume path with the base URI before making the form-post:

form_post_url = signinConfig.federation_resume_uri + resume_path.

nnlappsdk_url

The URL where the Nok Nok Web App SDK is located. Default value is "${host}/nnlappsdk-${appsdk_version}"

reg_endpoint

The registration endpoint for the API Server. Default value is "${host}/nnlgateway/nnl/${tenant_id}/reg"

storage_endpoint

The endpoint of the cookie based storage. The default value is "${host}/nnlgateway/storage"

ui_config_url

The URL of the root configuration directory for the JSON UI Configuration files used by nnlsignin. Default value is null. See App UI Customization for details on how to create your UI Configuration files, and see the section Storing Your UI Configuration Files Using a Remote Server for information about how to structure the directories that contain your UI configuration.

web_oob_url

The URL of the page that processes the scanned QR code for Appless OOB operations. Default value is "${host}/nnlsignin/oobrecv.html". This field is mandatory if you use OOB authentication.