Authentication

The authentication API allows to retrieve the hue-application-key, that is passed as header for Authorization.

Authenticate

post

Authenticate to retrieve the HUE application key. Requires to go and press the button on the bridge

Body

devicetypestringoptional

Example: app_name#instance_name

generateclientkeybooleanoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://192.168.1.0/api' \
  --header 'Content-Type: application/json' \
  --data '{
    "devicetype": "app_name#instance_name",
    "generateclientkey": true
  }'

application/json

200

401

200

Success

Error

Success

[
  {
    "success": {
      "username": "a4e08834-0893-4013-b646-738582ec15c9",
      "clientkey": "8c7f2f7e-efb5-4b89-9b54-aac797040ea4"
    }
  }
]

Authentication Success

You absolutely need to press the button on your Hue bridge before calling this endpoint. Otherwise, the response will contain the message "link button not pressed".

This is a security step so that only apps you want to control your lights can. By pressing the button, you prove that you have physical access to the bridge.