Login to application

post

https://{nurevaDeviceIP}/api/v1/auth/login

Runs a check to ensure that the user has the correct account role and password to login. On a successful response, receive an authorization parameter, which should be used to fill the part of the Authorization header for other endpoint requests. Authorization headers should look like 'Nureva authParameters', where authParameters is the authorization parameter from the response.

Example Request Body

{
    "account": "admin",
    "password": "ABC-ABC-ABC"
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

Nureva-Client-Id

string

required

Defaults to integration_app_name

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

Nureva-Client-Version

string

required

Defaults to 0.0.1

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Body Params

The request for Login endpoint.

account

string

enum

required

Defaults to general

The type of account to log in with. This is not your Nureva Console username. Use general for third-party integrations.

Allowed:

password

string

required

Defaults to ABC-ABC-ABC

The password for the account. This is not your Nureva Console password. By default for HDL310, HDL410, and HDX devices, the password is the device's enrollment code (XXX-XXX-XXX format), found on the device label marked "Enrollment Code".

Responses

200Success

400Unsupported attribute. Both attributes must be strings and both attributes must always exist in the request

401Unauthorized. Either account or password are incorrect

429Too many requests. Rate limit is exceeded

500Internal Server Error. Unexpected error has occurred.