Part 3: Authentication

Authentication

Now that you know your server is properly installed and configured, the first thing you will want to do is authenticate.

curl --location --request PUT 'http://localhost:8080/nuix-restful-service/svc/v1/authenticatedUsers/login' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
	"username":"username",
	"password":"password",
    "licenceShortName": "enterprise-workstation",
    "workers": 2
}'

{
    "username": "username", 
    "authToken": "9729a460-eda7-48dc-ba70-d12b3aae3c8d",
    "licenseShortName": "enterprise-workstation",
    "workersGranted": 2
}

Note

The licenceShortName and workers fields in the request body are optional. If they are excluded any license will be selected and 1 worker will be granted.

Note

Please note the authToken field returned in the response will need to be submitted in the nuix-auth-token request header field on all subsequent requests.

You have now successfully authenticated to Nuix RESTful Service!

Last modified February 9, 2021