Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Administrators

Update administrator details

Modify Administrator attributes, like Administrator Name, Timezone, and Status (either Active or Disabled).

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

patch/console/v1/admins/{globalAdminID}

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

adminNamestring

The name of the administrator.

timezonestring

The timezone of the administrator. Use IANA timezone format (e.g., UTC, Africa/Abidjan, America/Detroit, Asia/Dubai).

adminState'ACTIVE' | 'DISABLED'

Specify the new state of the admin.

Example request

{
  "adminName": "sample",
  "timezone": "UTC"
}

Response

Success

adminEmailstring

The email of the admin

adminNamestring

The name of the admin

adminStatestring

The new modified state of the admin

timezonestring

The timezone of the admin

globalAdminIdstring

The unique ID associated with the admin

globalCustomerIdstring

The unique ID associated with the customer

adGuidstring

The globally unique identifier

roleinteger

The role ID of the admin

provisioningModestring

The mode through which the admin was created

Example response

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