Objective

In addition to global datacenter rights, you can assign granular rights to users on specific objects in your Hosted Private Cloud vSphere inventory (for example, a VM or datastore). This guide explains how to add, view and remove these rights through the OVHcloud API.

Requirements

• A Hosted Private Cloud service with vSphere version 6.5 or higher
• Access to the OVHcloud API
• A user already created in your Hosted Private Cloud service

---

OVHcloud Control Panel Access

• Direct link: VMware vSphere
• Navigation path: Hosted Private Cloud > Managed VMware vSphere > Select your vSphere service

---

Instructions

Add rights to a vSphere object

1. Call the following API endpoint:

   🇪🇺EU▾

   POST/dedicatedCloud/{serviceName}/user/{userId}/objectRight

2. Fill in the request body with the object and user you want to grant access to.

   You can choose whether or not to propagate the right to child objects, similar to vSphere native rights.

3. Confirm the request. A task of type addUserObjectRight is created and applied on the vSphere object.

   For example, to grant read/write access on a VM:

   {
     "propagate": false,
     "right": "readwrite",
     "type": "vm",
     "vmwareObjectId": "vm-92"
   }

View a user's rights on a vSphere object

To view a specific right, you first need to know its objectRightId.

1. List all rights granted to the user by calling the following endpoint:

   🇪🇺EU▾

   GET/dedicatedCloud/{serviceName}/user/{userId}/objectRight

   Fill in the fields with the serviceName (service domain) and the userId (user identifier). The response returns the list of objectRightId identifiers of the rights granted to the user:

   [
     42,
     57,
     63
   ]

2. Call the following API endpoint to view the details of a specific right:

   🇪🇺EU▾

   GET/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId}

3. Fill in the fields with the objectRightId corresponding to the right you want to view.

4. Confirm the request. The response returns information about the right granted to the user on the vSphere object:

   {
     "name": "string",
     "objectRightId": 0,
     "propagate": false,
     "right": "admin",
     "type": "cluster",
     "vmwareObjectId": "string"
   }

Remove rights from a vSphere object

1. Call the following API endpoint:

   🇪🇺EU▾

   DELETE/dedicatedCloud/{serviceName}/user/{userId}/objectRight/{objectRightId}

2. Fill in the fields with the objectRightId corresponding to the right you want to remove.

3. Confirm the request. A task of type removeUserObjectRight is created and removes the user right from the vSphere object.

Go further

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Join our community of users.