Supervisor Authentication

Supervisor Authentication and Registration

The Supervisor Authenticator provides endpoints for managing supervisor service registration and forwarding login requests to the registered supervisor. This component acts as a proxy between clients and the registered supervisor service.

API

• Data:

  • SUPERVISOR_CONFIG object:

    {
        "host": "10.10.11.38",
        "registration_token": "token"
    }

  • SUPERVISOR_REGISTRATION_INFO object:

    {
        "host": "10.10.11.38"
    }

  • LOGIN_REQUEST object:

    {
        "username": "myusername",
        "password": "mypassword"
    }

• Display Supervisor Registration Information

  • Path: /sv/register

  • Method: GET

  • Payload: None

  • Description: Returns the current supervisor registration information (host only).

  • Response:

    • 200 OK: Returns SUPERVISOR_REGISTRATION_INFO object

  • Example:

    curl -X GET http://localhost:9090/sv/register \
         -H "token: your-auth-token"

• Register Supervisor

  • Path: /sv/register

  • Method: POST

  • Payload: SUPERVISOR_CONFIG

  • Description: Registers a supervisor service by storing its host and registration token. This configuration is persisted and will override any previous supervisor registration.

  • Response:

    • 200 OK: “Supervisor registered successfully”
    • 400 Bad Request:
      • “Empty payload” - when no payload is provided
      • “Registration token cannot be empty” - when registration_token field is empty
      • “Validation errors: …” - when JSON validation fails
      • “Invalid JSON format” - when JSON parsing fails

  • Example:

    curl -X POST http://localhost:9090/sv/register \
         -H "Content-Type: application/json" \
         -H "token: your-auth-token" \
         -d '{
             "host": "10.10.11.38",
             "registration_token": "token"
         }'

• Change Supervisor Registration Information

  • Path: /sv/register

  • Method: PUT

  • Payload: SUPERVISOR_CONFIG

  • Description: Updates the existing supervisor registration. A supervisor must already be registered.

  • Response:

    • 200 OK: “Supervisor registration updated successfully”
    • 404 Not Found: “No supervisor registered to update” - when no supervisor is currently registered
    • 400 Bad Request:
      • “Empty payload” - when no payload is provided
      • “Registration token cannot be empty” - when registration_token field is empty
      • “Validation errors: …” - when JSON validation fails
      • “Invalid JSON format” - when JSON parsing fails

  • Example:

    curl -X PUT http://localhost:9090/sv/register \
         -H "Content-Type: application/json" \
         -H "token: your-auth-token" \
         -d '{
             "host": "10.10.14.14:443",
             "registration_token": "token"
         }'

• Remove Previous Registration Information

  • Path: /sv/register

  • Method: DELETE

  • Payload: None

  • Description: Removes any existing supervisor registration information.

  • Response:

    • 200 OK: “Supervisor registration removed successfully”

  • Example:

    curl -X DELETE http://localhost:9090/sv/register \
         -H "token: your-auth-token"

• Login via Supervisor

  • Path: /sv/login

  • Method: POST

  • Payload: LOGIN_REQUEST

  • Description: Forwards login requests to the registered supervisor service. The request is proxied to http://{supervisor_host}/login and the supervisor’s response is returned to the client.

  • Response:

    • Proxied response from supervisor service (content-type: application/json)
    • 503 Service Unavailable: “Supervisor not registered” - when no supervisor is configured
    • 400 Bad Request:
      • “Empty payload” - when no payload is provided
      • “User and password are required” - when user or password fields are empty
      • “Validation errors: …” - when JSON validation fails
      • “Invalid JSON format” - when JSON parsing fails
    • 500 Internal Server Error: “Login forwarding failed” - when communication with supervisor fails

  • Example:

    curl -X POST http://localhost:9090/sv/login \
         -H "Content-Type: application/json" \
         -d '{
             "username": "myusername",
             "password": "mypassword"
         }'

Configuration Storage

The supervisor configuration is stored persistently in the daemon’s cache. This ensures that the supervisor registration persists across daemon restarts.

Back to Index