Nuix · Schema
AuthenticationRequest
Schema for AuthenticationRequest in Nuix REST API
ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence
Properties
| Name | Type | Description |
|---|---|---|
| username | string | The user requesting access to the service. |
| password | string | The password credentials for the requesting user. |
| workers | integer | The number of workers being used. This field is optional and if not provided then the user will get a single worker. |
| licenceShortName | string | The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the li |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-authenticationrequest.json",
"title": "AuthenticationRequest",
"description": "Schema for AuthenticationRequest in Nuix REST API",
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The user requesting access to the service."
},
"password": {
"type": "string",
"description": "The password credentials for the requesting user."
},
"workers": {
"type": "integer",
"format": "int32",
"description": "The number of workers being used. This field is optional and if not provided then the user will get a single worker.\n"
},
"licenceShortName": {
"type": "string",
"description": "The short name of the requested license. (UK Spelling). `licenseShortName` (US Spelling) is also accepted. If the user fails to provide the licence short name, then the licence that is first in the list provided by the licence server will be used. Both the UK and US spelling of the word are accepted.\n"
}
},
"required": [
"username",
"password"
]
}