DRdruva
Administrators

List all administrators

Returns the details of existing administrators in the Cloud Console.

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

get/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

Query parameters

pageSizeinteger

Specify the maximum number of records that should be returned in a response.

pageNumberinteger

Specify the desired page number

pageTokenstring

Specify the page token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'. NOTE: pageNumber and pageToken cannot be used together.</i>

sortBy'adminName' | 'email' | 'lastLogin'

Specify the field to sort the admins on

sortOrder'ASC' | 'DESC'

Specify the order in which the admins has to be sorted

searchStringstring

Specify the string to be searched on adminName

filtersstring
Example:{ "lastLogin": 1234567, "productId": [4097,8193,12289], "adminState": [ "ACTIVE","DISABLED" ], "provisioningMode": [ "Manual","AD_LDAP" ] }

Specify the filters to be applied

{
  "lastLogin": 1234567,
  "productId": [4097,8193,12289],
  "adminState": [
    "ACTIVE","DISABLED"
  ],
  "provisioningMode": [
    "Manual","AD_LDAP"
  ]
}

Filters Structure:

  • lastLogin (float): Specify the last login time on which the admins has to be filtered
  • productId (array of integers): Specify the productID(s) on which the admins has to be filtered. Allowed values: 4097 - DruvaCloud admins, 8193 - Insync Product admins, 12289 - Enterprise Workloads' Product admins
  • adminState (array of strings): Specify the list of admin states on which the admins has to be filtered. Allowed values: ACTIVE, DISABLED
  • provisioningMode (array of strings): Specify the list of creation modes on which the admins has to be filtered. Allowed values: Manual, AD_LDAP

Headers

Content-Type'application/json' required

Request content type header

Response

Success

globalCustomerIdstring

The unique ID associated with the customer

totalSizeinteger

The total number of admins wrt to the filters applied

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of the results.

Example response

{
  "globalCustomerId": "axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx",
  "totalSize": 57,
  "admins": [
    {
      "globalAdminId": "5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7",
      "adminEmail": "sample@gmail.com",
      "adminName": "sample",
      "lastLogin": 1703570381.19192,
      "role": "Druva Cloud",
      "provisioningMode": "AD_LDAP",
      "adminState": "DISABLED",
      "disabledThroughMode": "Manual",
      "adMappingId": 38,
      "disabledOnTS": 1708675426
    }
  ]
}

Changes

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