Invite a User to a Qubole Account
- POST /api/v1.2/users/invite_new
This API is used to invite new users to a Qubole account. New users are invited by an existing Qubole user of a Qubole account. After new users are added to the Qubole account, they become part of the system-users group by default.
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 inviting users to an account. 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 |
|---|---|
invitee_email |
Email address of the new user, who should be added to the Qubole account. |
account |
Account ID of the current user |
groups |
This parameter is used to add groups to the new user. By default, a new user is added to to the system-user group. |
|
This parameter defines the type of user to be created. Applicable values are service or regular. By default, a regular user is created. To enable service users for your account, create a ticket with Qubole Support . |
Request API Syntax
Here is the API request syntax.
curl -X POST -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"invitee_email":"<qubole email address>","account":"<account-ID>","groups":"<groups>", "user_type":"service" }' \
"https://api.qubole.com/api/v1.2/users/invite_new"
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 '{"invitee_email":"[email protected]","account":"4332","groups":"system-admin" }' \
"https://api.qubole.com/api/v1.2/users/invite_new"