Skip to main content
Version: Mosquitto 2.9

Profile Edit

User profile operations

Available API Paths​

Path: /api/profile/{userName}​

Methods​

PUT​

Updates a user's profile information

Parameters

NameLocationTypeRequiredDescription
userNamepathstringtrueUsername of the user to update
NameLocationTypeRequiredDescription
bodybodyundefinedtrueUser profile data to update. Username must be the same as userName in path parameters

Responses

Status Description Response Content or Scheme
200 An updated user profile object 
{
  "$ref": "#/components/schemas/MMCUser"
}
400 Request data is invalid 
{
  "code": {
    "type": "string",
    "enum": [
      "INVALID"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "User object invalid",
      "User must have at least one role"
    ],
    "description": "Message of the error"
  }
}
401 Access to resource is denied. User not authenticated (logged in) or session expired 
{
  "code": {
    "type": "string",
    "enum": [
      "UNAUTHORIZED"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Unauthorized"
    ],
    "description": "Message of the error"
  }
}
403 User does not have enough permissions to access the resource 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_ALLOWED"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Not allowed"
    ],
    "description": "Message of the error"
  }
}
404 Plugin is not enabled or not found 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_FOUND"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Plugin not found"
    ],
    "description": "Message of the error"
  }
}
410 Requested entity does not exists or was removed 
{
  "code": {
    "type": "string",
    "enum": [
      "GONE"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "User does not exist"
    ],
    "description": "Message of the error"
  }
}
500 An internal server error has occured 
{
  "code": {
    "type": "string",
    "enum": [
      "INTERNAL_ERROR",
      "SOMETHING_WRONG"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "An internal server error occurred"
    ],
    "description": "Message of the error"
  }
}