DRdruva
Administrators

Update administrator role

Change the role and product-level access control configuration for the specified administrator. The request body must contain the complete desired role configuration. Any existing role settings not included in the request will be removed. <br>Role behavior: <br>- Druva Cloud - The administrator gets full access across all products. The productAccessControls field is ignored. <br>- Product - The productAccessControls field is required and defines per-product role and resource-level access. <br> <br>The available product roles and access controls applicable for a role can be fetched using the List roles API.

📘 Note To use this API endpoint, enable the Administrator API from Druva Cloud settings.

put/console/v1/admins/{globalAdminID}/role

Request

  • Base URL
    https://apis.druva.com/platform
  • URL
    https://apis.druva.com/platform/console/v1/admins/{globalAdminID}/role
  • Auth
    API key in header Authorization

Path parameters

globalAdminIDstring required

The global ID of the admin on which the action has to be performed. Get the global ID of the administrator using the List all administrators API.

Headers

Content-Type'application/json' required

Request content type header

Request body

role'Product' | 'Druva Cloud' required

Select the role of the administrator.

  • Druva Cloud - Druva Cloud Administrator is a super administrator who gets all the rights of all the administrative roles across products, based on the services enabled for your account and the privileges needed to modify account settings.
  • Product - Product administrator can perform all core product-related activities such as configuring, managing, and monitoring.

Example request

{
  "productAccessControls": [
    {
      "productID": 8193,
      "productRole": "Profile Admin",
      "accessControl": [
        {
          "collectionName": "Default",
          "collectionID": 4,
          "resource": "Profiles",
          "itemList": []
        }
      ]
    }
  ]
}

Response

Success

globalAdminIdstring

The unique ID associated with the admin

globalCustomerIdstring

The unique ID associated with the customer

adminEmailstring

The email of the admin

adminNamestring

The name of the admin

rolestring

The role of the admin

Example response

{
  "globalAdminId": "5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7",
  "globalCustomerId": "axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx",
  "adminEmail": "sample@gmail.com",
  "adminName": "sample",
  "role": "Product"
}

Changes

No recorded changes to this operation across all 1 revision of this API.