Invite a new user to join your Vultr organization through IAM. Send an invitation that grants the user access to organizational resources upon acceptance.
Inviting a user to an organization sends them an email invitation to join. Once the user accepts the invitation, they become a member of the organization and can access resources based on the roles and policies assigned to them. Invitations expire after 3 days if not accepted.
This guide explains how to invite a user to an organization using the Vultr Console or the Vultr API.
Log in to the Vultr Console.
Click the organization name in the top navigation bar.
Click Manage Organization.
Click the Users tab.
Click the Add User button.
In the Add User panel, select the Invite Type as User.
Enter the user's Email Address.
Click Review and Invite.
Review the invitation details and click Send Invitation.
The invitation is sent to the user's email address. The user appears in the Invitations section with a status of Invite Pending until they accept.
Send a POST request to the Create Organization Invite endpoint to send the invitation. Replace USER-EMAIL with the email address of the user you want to invite. Set api_enabled to yes to grant API access to the invited user. The Vultr API key determines the target organization.
$ curl "https://api.vultr.com/v2/invitation" \
-X POST \
-H "Authorization: Bearer ${VULTR_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"email_invited": "USER-EMAIL",
"permissions": {
"api_enabled": "yes"
}
}'
A successful request returns an HTTP 201 Created response with an invite_status of Pending. Note the invitation id for tracking or resending.
After the user accepts the invitation, send a GET request to the Get Organization Invite endpoint to verify acceptance. Replace {invitation-id} with the id of the invitation. The invite_status changes to Accepted and the date_responded field shows when the user accepted.
$ curl "https://api.vultr.com/v2/invitation/{invitation-id}" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Verify that the invite_status field shows Accepted.