superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-users-by-pk.StatusCodes.json

{
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "result": {
                "properties": {
                  "active": {
                    "description": "Is user active?It's not a good policy to remove a user, just make it inactive",
                    "type": "boolean"
                  },
                  "email": {
                    "description": "The user's email",
                    "type": "string"
                  },
                  "first_name": {
                    "description": "The user's first name",
                    "type": "string"
                  },
                  "groups": {
                    "description": "The user's roles",
                    "items": { "type": "integer" },
                    "type": "array"
                  },
                  "last_name": {
                    "description": "The user's last name",
                    "type": "string"
                  },
                  "password": {
                    "description": "The user's password for authentication",
                    "type": "string"
                  },
                  "roles": {
                    "description": "The user's roles",
                    "items": { "type": "integer" },
                    "type": "array"
                  },
                  "username": {
                    "description": "The user's username",
                    "maxLength": 250,
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "type": "object",
                "title": "SupersetUserApi.put"
              }
            },
            "type": "object"
          },
          "example": {
            "result": {
              "active": true,
              "email": "string",
              "first_name": "string",
              "groups": [],
              "last_name": "string",
              "password": "string",
              "roles": [],
              "username": "string"
            }
          }
        }
      },
      "description": "Item changed"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Bad request: Invalid parameters provided" }
        }
      },
      "description": "Bad request"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Unauthorized: Authentication required" }
        }
      },
      "description": "Unauthorized"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": {
            "message": "Not found: The requested resource does not exist"
          }
        }
      },
      "description": "Not found"
    },
    "422": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": { "message": "Unprocessable entity: Validation error" }
        }
      },
      "description": "Could not process entity"
    },
    "500": {
      "content": {
        "application/json": {
          "schema": {
            "properties": { "message": { "type": "string" } },
            "type": "object"
          },
          "example": {
            "message": "Internal server error: An unexpected error occurred"
          }
        }
      },
      "description": "Fatal error"
    }
  }
}