Create a Group

POST /api/v1.2/groups

This API is used to create a group on QDS.

Required Role

The following users can make this API call:

  • Users who belong to the system-user or system-admin group.
  • Users who belong to a group associated with a role that allows creating a group. See Managing Groups and Managing Roles for more information.

Parameters

Note

Parameters marked in bold are mandatory. Others are optional and have default values.

Parameter Description
name Name of the group that must be unique in the Qubole account.
members An array of Qubole users’ email addresses, who are already members of the Qubole account.
roles An array of Qubole role IDs or role names. Once a Qubole group is created, roles are attached to the group.

Request API Syntax

Here is the request API syntax.

curl -X POST -H "X-AUTH-TOKEN:  $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name":"<group-name>","members":"<member1,member2,..","roles":"<role1>,<role2>,..."}' \
"https://api.qubole.com/api/v1.2/groups"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Sample Request

Here is a sample request.

curl -X POST -H "X-AUTH-TOKEN:  $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name":"my_group_name","members":"71,72","roles":"1,2"}' \ "https://api.qubole.com/api/v1.2/groups"

Sample Response

Success
{"status":"done"}