Endpoint

/v1/groups/

GET

List all groups. Refer to the 'Modify group' method for a description of the returned fields.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "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"
      }
    }
  }
}

POST

Add a group.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_group_post",
  "type": "object",
  "properties": {
    "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"
    }
  }
}