List Groups with a Specific Role

GET /api/v1.2/roles/<role-id/name>/groups

This API is used to list groups assigned with a particular role.

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 viewing groups assigned with a specific role. 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
<role-id/name> ID or name of the role to list associated groups of the current account

Request API Syntax

Here is the syntax of the Request API.

curl -X GET -H "X-AUTH-TOKEN:  $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{}' \ "https://api.qubole.com/api/v1.2/roles/<role-id/name>/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

curl -X GET -H "X-AUTH-TOKEN:  $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{}' \ "https://api.qubole.com/api/v1.2/roles/system-admin/groups"