DRdruva
Administrators

Create an administrator

Creates an administrator in the Druva Console.

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

post/console/v1/admins

Request

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

Headers

Content-Type'application/json' required

Request content type header

Request body

adminEmailstring required

The email address of the administrator you want to create.

adminNamestring required

The name of the administrator you want to create.

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.
timezonestring required

Specify the timezone of the administrator.

provisioningMode'Manual' | 'AD_LDAP' required

The mode through which the admin is being created.

adminState'ACTIVE' | 'DISABLED'

The state of the admin to be created.

adGuidstring

The globally unique identifier

adMappingIdinteger

The unique AD Mapping ID.

adMappingNamestring

The AD Mapping name.

druvaDomainLegalConsentboolean

Setting this parameter to True indicates you consent to creating a Druva administrator account with an email address ending in druva.com or druva.org.

Example request

{
  "adminEmail": "sample@gmail.com",
  "adminName": "sample",
  "timezone": "UTC",
  "productAccessControls": {
    "products": [
      {
        "productID": 8193,
        "productRole": "Profile Admin",
        "accessControls": [
          {
            "collectionName": "Default",
            "collectionID": 4,
            "resource": "Profiles",
            "itemList": []
          }
        ]
      }
    ]
  },
  "adMappingId": 17890,
  "adMappingName": "mappingName"
}

Response

Success

globalCustomerIdstring

The unique ID associated with the customer

globalAdminIdstring

The unique ID associated with the admin

adminEmailstring

The email associated with the admin

adminNamestring

The name of the admin

rolestring

The role of the admin

provisioningModestring

The mode through which the admin was created

adminStatestring

The state of the created admin

adGuidstring

The globally unique identifier

disabledThroughModestring

The mode through which the admin was disabled(Applicable only if the Admin is in DISABLED state)

deletionEpochnumber float

The deletion epoch in case the admin is marked for deletion

deletionTimestring date-time

The deletion time in case the admin is marked for deletion. The time is in the UTC time zone. Example - 2024-01-04T09:06:02.191Z

Example response

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

Changes

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