Register Owner

• Summary: The register owner API is used by the administrator to register new owners with the middleware

Request

• Endpoint: https://localhost/admin/register-owner

• Method: POST

• Security Scheme: Admin credentials

• Required Headers:

  Header Name	Description
  owner	Name of the owner being registered

Responses

• 201 Created

  • The owner has been successfully created:

    {
        "id": "streetlight-owner",
        "apikey": "BdPujwdwmMXpcXRpAuwwNfasGeTHeYgK"
    }
    

• 400 Bad Request

  • If the owner name is not valid:

    {
        "error": "entity should be a valid owner"
    }
    

  • If any headers are missing from the request:

    {
        "error": "inputs missing from headers"
    }
    

• 403 Forbidden

  • If this API is being called from outside localhost:

    {
        "error": "this api can only be called from localhost"
    }
    

  • If a user other than admin tries to invoke this API:

    {
        "error": "only admin can call this api"
    }
    

  • If the name of the owner being created is reserved, i.e is one of admin, validator or database:

    {
        "error": "cannot create the user"
    }
    

• 409 Conflict

  • If the owner id is already in use:

    {
        "error": "id already used"
    }