Licensing Configuration

During installation, Nuix RESTful Service can be configured to acquire licenses from either an available Nuix Management Server (NMS) or the Nuix Cloud License Server (CLS). After installation, you may need to eventually update the URL, server type, or credentials being used to acquire licenses. Use the details within this topic to update your license server connection information.

Nuix RESTful Service supports the following four license server types:

• Nuix Management Server (NMS)

  Acquire licenses directly from an NMS instance.

• Relay server with NMS users

  Connect to an NMS instance configured as a relay server to acquire licenses from CLS using NMS user authentication.

• Relay server with CLS users

  Connect to an NMS instance configured as a relay server to acquire licenses from CLS using CLS user authentication.

• Cloud License Server (CLS)

  Acquire licenses directly from CLS.

Updating License Server Configurations

To update the license server configuration of your Nuix RESTful Service installation:

Prerequisites:

• If configuring CLS for licensing, you must have a valid CLS user account and credentials to connect to the Nuix CLS portal (https://my.nuix.com).
• Ensure that Nuix RESTful service is not running by closing the application or stopping the service before proceeding.

Configuration:

1. Navigate to the settings directory within the location where Nuix RESTful Service is installed.

   • Windows: C:\Program Files\Nuix\Nuix RESTful Service\settings
   • Debian/Ubuntu: /opt/nuix-restful-service/settings

2. Locate and open the application.properties file within a text editor.

3. Update the following properties with values based on the license server type being used.

   nuix.license.source=

   Specify the server type to use. Valid values include:

   • server - Nuix Management Server (NMS)
   • local-relay-server-local-users - Relay server with NMS users
   • local-relay-server-cls-users - Relay server with CLS users
   • cloud-server - Cloud License Server (CLS)

   nuix.registry.servers=

   The URL of the licensing server being used. To connect to CLS, specify licence-api.nuix.com.

4. Save and exit the file.

5. Restart Nuix RESTful Service for the changes to take effect.

If the credentials for accessing the license server have changed, proceed to the next section.

Updating License Server Credentials

The stored credentials used to access your configured license server can be updated directly using the API.

To update the credentials associated with your specific NMS or CLS connection:

1. Submit a request to the ​/authenticatedUsers​/login endpoint to log in and acquire a license using your updated credentials.

   curl -L -X PUT 'http://127.0.0.1:8080/nuix-restful-service/svc/authenticatedUsers/login' \
   -H 'Content-Type: application/json' \
   --data-raw '{
       "username": "user1",
       "password": "newPassword",
       "licenseShortName": "enterprise-workstation",
       "workers": 2
   }'
   

   {
     "username": "user1",
     "authToken": "49e225d7-b88d-4d1b-9cbc-296e83706a60",
     "licenseShortName": "enterprise-workstation",
     "workersGranted": 1
   }
   

2. Using the acquired authentication token, call the licenseServer/credentials endpoint, providing your updated license server credentials.

   curl --location --request PUT 'localhost:8080/nuix-restful-service/svc/v1/licenseServer/credentials' \
   --header 'Content-Type: application/json' \
   --header 'nuix-auth-token: 49e225d7-b88d-4d1b-9cbc-296e83706a60' \
   --data-raw '{
     "username": "user1",
     "password": "newPassword"
   }'
   

   {
       "message": "Success.",
       "status": "PERSISTENT"
   }
   

If the call is made successfully, and the provided credentials are valid, the password will be encrypted and the following properties within the application.properties file will be automatically updated, replacing any previous values.

• nuix.license.server.username=

  Username of the CLS or NMS account being used for license acquisition.

• nuix.license.server.securePassword=

  The encrypted password associated with the license server username.