PUT /platforms/:platform/auths/:auth_user_id

[davidraker]

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

If not all fields in the record are provided, only those which have been provided will be updated. Other fields will remain the same.

Note: :auth_user_id can take any value specified in a user_id field in an auth record on the system. 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.

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: 204 No Content

• With valid BEARER token on failure: 400 Bad Request

  • Content Type: application/json
  • Body:

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

• With invalid BEARER token: 401 Unauthorized