auth
The auth command authorizes a device against the server's device authentication key. Device authentication is a security feature, similar to claiming: once authentication is enabled, only authorized devices participate in the system.
| Command Type | SDVoE |
| Minimum Version | 3.x.x |
Usage
auth <device> [<arguments>]
Arguments
| Argument | Required | Description |
|---|---|---|
device | Yes | Device name, MAC address, or device ID. Names are substituted with the MAC address automatically. |
arguments | No | Any additional arguments are passed through to the underlying SDVoE API command. |
The server's device authentication key is the device_auth_key value, set via the config command (server scope; readable only as Admin). Key changes require a service restart. Apply them with server applypending before authorizing devices.
Examples
Authorize a device by nameauth room_projector
Return value
auth is processed asynchronously. The immediate reply is PROCESSING with a request_id. Read the outcome with request.
auth room_projector{
"status": "PROCESSING",
"request_id": 42,
"result": null,
"error": null
}
Errors
| Error | Cause |
|---|---|
Server Claim/Auth Key change is pending... | A claim/auth key change has not been applied yet. Run server applypending first |
Invalid parameters | No device was given |
REST API
Although auth originates in the SDVoE API, the REST example below uses a DisplayNet API operation. Use the endpoint shown here. DisplayNet uses it to maintain its own device records.
| Endpoint type | DisplayNet API command |
|---|---|
| Address | POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands. |
| Role | Admin |
| Operation | Parameters |
|---|---|
auth | device [args]* |
A parameter in brackets is optional. A parameter marked * takes the remainder of the command line as one string. Pass the text exactly as you would type it on the TCI interface.