Delete Users from an Existing Group¶
-
PUT
/api/v1.2/groups/<qubole-group-id/name>/qbol_users/<user-email-address>/remove
¶
This API is used to delete users in an existing group on QDS.
Required Role¶
The following users can make this API call:
- Users who belong to the system-admin or system-user group.
- Users who belong to a group associated with a role that allows deleting users from 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 |
---|---|
<qubole_group_id/name> | ID or name of the group that contains users, who must be deleted. |
<user-email-address> | An array of the email addresses of users who belong to the Qubole group. |
Request API Syntax¶
Here is the API request syntax.
curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{}' \ "https://gcp.qubole.com/api/v1.2/groups/<qubole-group-id/name>/qbol_users/<<user-id>/<user-email-address>>/remove"
Sample Request¶
Here is a sample request.
curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://gcp.qubole.com/api/v1.2/groups/106/qbol_users/73,74/remove"