WebSocket Permissions

WebSocket uses API Client permissions. The service validates the current client, application, account, and device state when creating a ticket and executing requests.

Request	Required permission
`session.ping`	Authenticated connection
`device.state.get`	`device:read`
`device.operation.execute` + `device.relay.set`	`device:control`
`device.operation.execute` + `device.rs485.transceive`	`device:control`
`device.operation.execute` + `device.rs485.baudRate.set`	`device:config`
`device.operation.execute` + `device.relay.jogConfig.set`	`device:config`

A missing permission returns:

json

{
  "type": "reply",
  "requestId": "req_relay_001",
  "code": "AUTH_SCOPE_DENIED",
  "message": "This operation requires the device:control permission. Update the API Client permissions in the Developer Console and obtain a new access token.",
  "data": {
    "requiredScope": "device:control"
  }
}

After changing API Client permissions, obtain a new access token and create a new WebSocket ticket. Do not continue using a token issued before the permission change.

WebSocket Permissions ​

WebSocket Permissions