/v1/users/{id} | Qumulo Documentation

Endpoint

/v1/users/{id}

GET

Retrieve information about a single local user. Refer to the 'Modify user' method for a description of the returned fields.

Parameters

Name	Description	Required
`id`	The user's unique ID	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_user",
  "type": "object",
  "properties": {
    "id": {
      "description": "The user's unique id",
      "type": "string"
    },
    "name": {
      "description": "The user's account name",
      "type": "string"
    },
    "primary_group": {
      "description": "The unique ID of the user's group",
      "type": "string"
    },
    "sid": {
      "description": "The users's SID",
      "type": "string"
    },
    "uid": {
      "description": "The user's NFS uid",
      "type": "string"
    },
    "home_directory": {
      "description": "The path to the user's home directory",
      "type": "string"
    },
    "can_change_password": {
      "description": "Specifies whether the user can change the password",
      "type": "boolean"
    }
  }
}

PUT

Modify a local user.

Parameters

Name	Description	Required
`id`	The user's unique ID	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_user_put",
  "type": "object",
  "properties": {
    "id": {
      "description": "The user's unique ID",
      "type": "string"
    },
    "name": {
      "description": "The user's account name",
      "type": "string"
    },
    "primary_group": {
      "description": "The user group's unique ID",
      "type": "string"
    },
    "uid": {
      "description": "The user's NFS UID",
      "type": "string"
    },
    "home_directory": {
      "description": "The user's home directory path",
      "type": "string"
    },
    "password": {
      "description": "The user's password",
      "type": "string",
      "format": "password"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_user",
  "type": "object",
  "properties": {
    "id": {
      "description": "The user's unique id",
      "type": "string"
    },
    "name": {
      "description": "The user's account name",
      "type": "string"
    },
    "primary_group": {
      "description": "The unique ID of the user's group",
      "type": "string"
    },
    "sid": {
      "description": "The users's SID",
      "type": "string"
    },
    "uid": {
      "description": "The user's NFS uid",
      "type": "string"
    },
    "home_directory": {
      "description": "The path to the user's home directory",
      "type": "string"
    },
    "can_change_password": {
      "description": "Specifies whether the user can change the password",
      "type": "boolean"
    }
  }
}

DELETE

Delete a local user.

Parameters

Name	Description	Required
`id`	The user's unique ID	Yes

Response

Codes

Code	Description
200	Return value on success