Endpoint

/v1/groups/{group_id}/members/

GET

List members of a group, which are among the local users. Refer to the 'Modify user' method for a description of the returned fields.

Parameters

Name Description Required
group_id The group's unique ID Yes

Response

Codes

Code Description
200 Return value on success

Schema

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

POST

Add a member to a group. Refer to the 'Modify user' method for a description of the returned fields.

Parameters

Name Description Required
group_id The group's unique ID Yes

Request

Schema

{
  "description": "api_member_auth_id",
  "type": "object",
  "properties": {
    "member_id": {
      "description": "Unique ID of a user",
      "type": "string"
    }
  }
}

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"
    }
  }
}