/v1/groups/{id} | Qumulo Documentation

Endpoint

/v1/groups/{id}

GET

Retrieve the attributes of a group. Refer to the 'Modify group' method for a description of the returned fields.

Parameters

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

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_group",
  "type": "object",
  "properties": {
    "id": {
      "description": "The group's unique id",
      "type": "string"
    },
    "name": {
      "description": "The group name",
      "type": "string"
    },
    "sid": {
      "description": "The group's SID",
      "type": "string"
    },
    "gid": {
      "description": "The group's NFS gid",
      "type": "string"
    }
  }
}

PUT

Modify a group. The 'id' field must match the id in the URI.

Parameters

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

Request

Schema

{
  "description": "api_group_put",
  "type": "object",
  "properties": {
    "id": {
      "description": "The group's unique id",
      "type": "string"
    },
    "name": {
      "description": "The group name",
      "type": "string"
    },
    "gid": {
      "description": "The group's NFS gid",
      "type": "string"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_group",
  "type": "object",
  "properties": {
    "id": {
      "description": "The group's unique id",
      "type": "string"
    },
    "name": {
      "description": "The group name",
      "type": "string"
    },
    "sid": {
      "description": "The group's SID",
      "type": "string"
    },
    "gid": {
      "description": "The group's NFS gid",
      "type": "string"
    }
  }
}

DELETE

Delete a group.

Parameters

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

Response

Codes

Code	Description
200	Return value on success