POST /platforms/:platform/auths

[davidraker]

Create authentication/authorization record for an agent running in the VOLTTRON platform.

The <user_id> will become the :auth_user_id in the route returned in the Location header of the response.

Note: A <user_id> can take any value but should be unique on the platform. For local agents, this should be the actual VIP identity. The string, however is arbitrary and may have other values for remote agents to distinguish them from local versions of the same agent. Attempting to create an authorization entry will return 409 Conflict with a Content-Location header pointing to the route of the conflicting record.

Request:

• Authorization: BEARER <jwt_token>
• Content Type: application/json
• Body:

   {
       "domain": "<domain>",
       "address": "<address>",
       "user_id": "<user_id>",
       "capabilities": ["<capability>", ...],
       "roles": ["<role>", ...],
       "groups": ["<group>", ...],
       "mechanism": "<mechanism>",
       "credentials": "<public_key>",
       "comments": "<comments>",
       "enabled": true|false
   }
  

Response:

• With valid BEARER token on success: 201 Created

  • Location: /platforms/:platform/auths/:auth_user_id

• With valid BEARER token on failure due to conflicting user_id: 409 Conflict

  • Content-Location: /platforms/:platform/auths/:auth_user_id
  • Body:

    {
        "error": "Resource <:auth_user_id> already exists."
    }
    

• With valid BEARER token on other failure: 400 Bad Request

  • Content Type: application/json
  • Body:

    {
        "error": "<Error Message>"
    }
    

• With invalid BEARER token: 401 Unauthorized