{"openapi":"3.0.1","info":{"title":"Platform","description":"Platform Public APIs","version":"1.0.0"},"servers":[{"url":"https://apis.druva.com/platform"}],"security":[{"Bearer":[]}],"tags":[{"name":"Reports"},{"name":"Events"},{"name":"Admin Roles"},{"name":"Administrators"},{"name":"Administration"}],"paths":{"/reporting/v1/reports":{"get":{"tags":["Reports"],"summary":"List Reports","description":"Returns the list of accessible reports for provided list of productIDs.","operationId":"GetReportsListRequest","parameters":[{"name":"productIDs","in":"query","description":"Provide comma-separated Product IDs. Possible values are 8193 - Endpoints, 8196 - Salesforce, 8197 - Data Governance, 12289 - Enterprise Workloads, 36880 - Cyber Resilience.","required":false,"style":"form","explode":true,"schema":{"type":"string","x-go-name":"ProductIDs"},"x-go-name":"ProductIDs"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReportsListResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/reporting/{version}/reports/{reportID}":{"post":{"tags":["Reports"],"summary":"Get Report","description":"Returns the selected report. Use the report ID field to specify the report that you want to fetch. By default the report provides the data for last 24 hours if no date/time filters are selected. For more information, see [guides on the Reports API](/docs/getting-started-with-reports-api).","operationId":"GetReportDataRequest","parameters":[{"name":"reportID","in":"path","description":"Unique ID of report.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["dgDataProtectionRisk","dgRollbackActions","dgUnusualDataActivityAlerts","dgDataAccessEvents","dgAdminLoginEvents","dgQuarantineResources","dgMaliciousScanJob","dgCuratedSnapshots","dgeDiscoveryDownloadJobsReport","dgGlobalCustodianReport","dgNonCompliantFileReport","dgArchivedNonCompliantFileReport","dgNonCompliantEmailReport","dgArchivedNonCompliantEmailReport","dgDefensibleDeleteForFilesReport","dgDefensibleDeleteForEmailsReport","epAlert","epDeletedDevice","epInactiveDevices","epLastBackupStatus","epLicenseUsage","epPreservedUsersDatasources","epRestoreActivity","epSharedDevices","epUpgradeActivity","epUserProvisioning","epUserRollout","epUsers","epStorageConsumption","ewAdminAuditTrails","ewAlertHistory","ewBackupActivity","ewDisasterRecoveryFailbackActivity","ewDisasterRecoveryFailoverActivity","ewDisasterRecoveryReplicationActivity","ewResourceStatus","ewRestoreActivity","ewStorageConsumptionbyBackupSets","m365SharePointSiteDiscovery","m365TeamsDiscovery","m365GroupsDiscovery","m365Alerts","m365LicenseUsage","m365PreservedUsersDatasources","m365StorageConsumption","m365UserCountAndStatus","m365UserLastBackupStatus","m365UserProvisioning","m365UserRestoreActivity","m365UserWorkload","m365SharePointBackupActivity","m365SharePointRestoreActivity","m365TeamsBackupActivity","m365TeamsRestoreActivity","m365GroupsBackupActivity","m365GroupsRestoreActivity","m365PublicFolderBackupActivity","m365PublicFolderRestoreActivity","googleAlerts","googleLicenseUsage","googlePreservedUsersDatasources","googleStorageConsumption","googleUserCountAndStatus","googleUserLastBackupStatus","googleUserProvisioning","googleUserRestoreActivity","googleUserWorkload","googleSharedDriveBackupActivity","googleSharedDriveRestoreActivity","sfdcArchivalActivity","sfdcArchivalRestoreActivity","sfdcBackupActivity","sfdcDataRestoreActivity","sfdcSandboxSeedingActivity"]}},{"name":"version","in":"path","description":"Version of report.\n<br>Note: With API enhancements in V2, you may see additional fields in the response over time. Avoid enforcing overly strict schema enforcement to ensure smooth integration.","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"v2","enum":["v1","v2"]}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_reportID_body"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReportDataResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"x-codegen-request-body-name":"requestBody"}},"/eventmanagement/{version}/events":{"get":{"tags":["Events"],"summary":"List Events","description":"This API returns a list of events based on pageToken or filters.\n<br>You can query using the pageToken or filters; you cannot provide both simultaneously.\n<br>When using the pageToken parameter, the initial request should not include any pageToken value. The response will contain a list of events and a nextPageToken. For subsequent API calls, include the pageToken parameter with the value of nextPageToken received from the previous API response. This ensures that you retrieve the next page of events.\n<br>For example\n  <br> /events?pageToken=qwwzsx1qwer0efjdvfhuvuvvuvu\n  <br> /events?pageSize=150&productID=12289&syslogSeverity=5\n","operationId":"ListEventsRequest","parameters":[{"name":"version","in":"path","description":"Version of report. In v1, the `details` field of the response provides a string. In v2 and v3 it provides a json object. In v1 and v2, feature and type fields are in camel case. In v3 they are title case.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["v1","v2","v3"],"default":"v3"}},{"name":"pageToken","in":"query","description":"Specify the 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'.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Specify the maximum number of records that should returned in a response. Maximum limit is 500 records. Default pageSize is 500.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"productID","in":"query","description":"Provide productID. Use 12289 for Enterprise Workloads.","required":false,"style":"form","explode":true,"schema":{"type":"integer"}},{"name":"category","in":"query","description":"Provide category. Use EVENT.","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Provide the type of action/incident that occurred on a particular entity. For example, Login, Logout, LicenseExpired, etc.","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1,"maxLength":128}},{"description":"Provide the feature for which you want to retrieve events. For example, Job, Admin, Customer, Client etc.","in":"query","name":"feature","schema":{"type":"string","minLength":1,"maxLength":128}},{"name":"syslogSeverity","in":"query","description":"Specify the severity code as follows:\n<br>For Emergency use 0\n<br>For Alert (action must be taken immediately) use 1\n<br>For Critical (critical conditions) use 2\n<br>For Error (error conditions) use 3\n<br>For Warning (warning conditions) use 4\n<br>For Notice (normal but significant condition) use 5\n<br>For Informational (informational messages) use 6\n<br>For Debug (debug-level messages) use 7\n","required":false,"style":"form","explode":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ListEventsResponse"},{"$ref":"#/components/schemas/ListEventsResponseTwo"},{"$ref":"#/components/schemas/ListEventsResponseThree"}]}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/console/v1/roles/{productID}":{"get":{"tags":["Admin Roles"],"summary":"List roles","description":"Returns the list of Product Administrator Roles and the resources they can access.","operationId":"ListRolesRequest","parameters":[{"name":"productID","in":"path","description":"Possible values are 8193 - Endpoints and SaaS Apps, 12289 - Enterprise Workloads","required":true,"style":"simple","explode":false,"schema":{"type":"integer","enum":[8193,12289]}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/console/v1/admins":{"get":{"tags":["Administrators"],"summary":"List all administrators","description":"Returns the details of existing administrators in the Cloud Console. \n > 📘 Note \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators).","operationId":"ListAdminsRequest","parameters":[{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}},{"name":"pageSize","in":"query","description":"Specify the maximum number of records that should be returned in a response.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","default":100}},{"name":"pageNumber","in":"query","description":"Specify the desired page number","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","default":1}},{"name":"pageToken","in":"query","description":"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'. \n NOTE: pageNumber and pageToken cannot be used together.</i>","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specify the field to sort the admins on","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"adminName","enum":["adminName","email","lastLogin"]}},{"name":"sortOrder","in":"query","description":"Specify the order in which the admins has to be sorted","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ASC","enum":["ASC","DESC"]}},{"name":"searchString","in":"query","description":"Specify the string to be searched on adminName","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"filters","in":"query","description":"Specify the filters to be applied\n```json\n{\n  \"lastLogin\": 1234567,\n  \"productId\": [4097,8193,12289],\n  \"adminState\": [\n    \"ACTIVE\",\"DISABLED\"\n  ],\n  \"provisioningMode\": [\n    \"Manual\",\"AD_LDAP\"\n  ]\n}\n```\n**Filters Structure:**\n- `lastLogin` (float): Specify the last login time on which the admins has to be filtered\n- `productId` (array of integers): Specify the productID(s) on which the admins has to be filtered. Allowed values:\n  4097 - DruvaCloud admins,\n  8193 - Insync Product admins,\n  12289 - Enterprise Workloads' Product admins\n- `adminState` (array of strings): Specify the list of admin states on which the admins has to be filtered. Allowed values:\n  ACTIVE, DISABLED\n- `provisioningMode` (array of strings): Specify the list of creation modes on which the admins has to be filtered. Allowed values:\n  Manual, AD_LDAP\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"{   \"lastLogin\": 1234567,   \"productId\": [4097,8193,12289],   \"adminState\": [     \"ACTIVE\",\"DISABLED\"   ],   \"provisioningMode\": [     \"Manual\",\"AD_LDAP\"   ] }"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAdminsResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"post":{"tags":["Administrators"],"summary":"Create an administrator","description":"Creates an administrator in the Druva Console.\n > 📘 **Note** \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators).","operationId":"CreateAdminRequest","parameters":[{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_admins_body"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdminResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/console/v1/admins/{globalAdminID}":{"get":{"tags":["Administrators"],"summary":"Get administrator details","description":"Returns the details of the specified administrator. \n > 📘 **Note** \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators).","operationId":"GetAdminRequest","parameters":[{"name":"globalAdminID","in":"path","description":"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](/reference/listadminsrequest) API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdminResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"delete":{"tags":["Administrators"],"summary":"Delete an administrator","description":"Deletes the specified administrator account from the Cloud Console. \n > 📘 **Note** \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators  ).","operationId":"DeleteAdminRequest","parameters":[{"name":"globalAdminID","in":"path","description":"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](/reference/listadminsrequest) API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAdminResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}},"patch":{"tags":["Administrators"],"summary":"Update administrator details","description":"Modify Administrator attributes, like Administrator Name, Timezone, and Status (either Active or Disabled). \n > 📘 **Note** \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators).","operationId":"UpdateAdminRequest","parameters":[{"name":"globalAdminID","in":"path","description":"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](/reference/listadminsrequest) API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admins_globalAdminID_body"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/console/v1/admins/{globalAdminID}/role":{"put":{"tags":["Administrators"],"summary":"Update administrator role","description":"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.\n<br>**Role behavior:**\n<br>- **Druva Cloud** - The administrator gets full access across all products. The productAccessControls field is ignored.\n<br>- **Product** - The productAccessControls field is required and defines per-product role and resource-level access.\n<br>\n<br>The available product roles and access controls applicable for a role can be fetched using the [List roles](/reference/listrolesrequest) API. \n > 📘 **Note** \n To use this API endpoint, enable the [Administrator API from Druva Cloud settings](/reference/administrators).","operationId":"UpdateAdminRoleRequest","parameters":[{"name":"globalAdminID","in":"path","description":"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](/reference/listadminsrequest) API.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admins_globalAdminID_role_body"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminRoleResponse"}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"The requested resource was not found.","content":{}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/console/v1/admin/password":{"post":{"tags":["Administrators"],"summary":"Change an administrator's password","description":"Changes an adiminstrator's password.","operationId":"ChangeAdminPassword","parameters":[{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin_password_body"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordResponse"}}}},"403":{"description":"User is not authorized to access this resource with an explicit deny","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"422":{"description":"Could be one of: \n - Password does not match password policy. Please check password policy. \n - Incorrect current password.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/auth/v3/customers/safemode/activate":{"post":{"tags":["Administration"],"summary":"Activate Safe mode","description":"This API initiates Safe Mode on your Cloud Console, imposing critical restrictions to mitigate active threats. It enables granular control by restricting administrator logins, blocking specified API credentials, and halting all backup operations, restores, and downloads.\n * This operation requires API credentials with the Druva Cloud Administrator role.\n * Safe Mode is activated immediately upon successful API call.","operationId":"CreateSafeModeActivationSettings","parameters":[{"name":"Content-Type","in":"header","description":"Request content type header","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activationInfo":{"type":"object","description":"Configuration details for activating Safe Mode.","properties":{"activationFor":{"type":"object","description":"Defines the specific restrictions to enforce when Safe Mode is activated. At least one restriction must be set to 'true'.","properties":{"restrictAdminLogin":{"type":"boolean","description":"If 'true', restricts administrator login access to the Cloud Console. Only administrators specified in allowedAdminIds will be permitted to log in."},"restrictApiCredentials":{"type":"boolean","description":"If 'true', restricts all API credential access. Only client credentials specified in allowedClientCredentialIds will be able to authenticate."},"stopBackup":{"type":"boolean","description":"If 'true', halts all scheduled backup operations across the customer environment."},"stopRestoreDownload":{"type":"boolean","description":"If 'true', prevents all data restore and download operations."}},"required":["restrictAdminLogin","restrictApiCredentials","stopBackup","stopRestoreDownload"],"additionalProperties":false},"allowedAdminIds":{"type":"array","description":"List of administrator global IDs that will retain login access when restrictAdminLogin is 'true'.\n * Get the global Admin ID of the administrator using the [List all administrators](/reference/listadminsrequest) API.\n * This parameter is required only if restrictAdminLogin is 'true'.","items":{"type":"string","description":"Global admin ID"},"uniqueItems":true},"allowedClientCredentialIds":{"type":"array","description":"List of client credential IDs that will retain API access when restrictApiCredentials is 'true'.\n * You can get the Client Credential ID from Integration Center > API Credentials > Client ID column.\n * This parameter is required only if restrictApiCredentials is 'true'.","items":{"type":"string","description":"Client credential ID"},"uniqueItems":true},"notificationEmailRecipients":{"type":"array","description":"A list of email addresses to notify about Safe Mode activation. Druva Cloud Administrator emails are included by default (no need to provide in input). Maximum of 20 recipients allowed.","items":{"type":"string","format":"email","description":"Email address of notification recipient"},"maxItems":20,"uniqueItems":true}},"required":["activationFor","allowedAdminIds","allowedClientCredentialIds","notificationEmailRecipients"],"additionalProperties":false}},"required":["activationInfo"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSafeModeActivationSettingsResponse"}}}},"403":{"description":"User is not authorized to access this resource with an explicit deny","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"422":{"description":"Could be one of: \n - Password does not match password policy. Please check password policy. \n - Incorrect current password.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}},"500":{"description":"The request was not processed due to an internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}}},"components":{"schemas":{"APIError":{"type":"object","properties":{"code":{"type":"string","x-go-name":"Code"},"data":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Data"},"message":{"type":"string","x-go-name":"Message"},"retryable":{"type":"boolean","x-go-name":"Retry"}},"description":"APIError defines an application error result format","x-go-package":"druva.com/godevkit/errortype"},"GetReportsListResponse":{"title":"GetReportsListResponse ...","type":"object","properties":{"reports":{"type":"array","items":{"$ref":"#/components/schemas/Report"},"x-go-name":"Report"}},"x-go-package":"git.druva.org/druva.com/dcp-reporting-service/spec/api"},"Report":{"title":"Report ...","type":"object","properties":{"reportID":{"type":"string","description":"The unique ID given for the report.","example":"dgRollbackActions","x-go-name":"ReportID"},"reportName":{"type":"string","description":"The name of the report.","example":"Rollback Actions Report","x-go-name":"ReportName"},"reportDescription":{"type":"string","description":"The description of the report.","example":"Details of deleted, rolled back, and permanently deleted entities.","x-go-name":"ReportDescription"},"productName":{"type":"string","description":"The name of the associated product.","example":"Cyber Resilience","x-go-name":"ProductName"},"version":{"type":"string","description":"The version supported for the report. Example - v1","example":"v1","x-g-name":"Version"}},"x-go-package":"git.druva.org/druva.com/dcp-reporting-service/spec/api"},"GetReportDataResponse":{"title":"GetReportDataResponse ...","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReportData"},"x-go-name":"Data"},"lastSyncTimestamp":{"type":"string","description":"Time stamp until which report data is returned in the API. The time is in the UTC time zone.","format":"date-time","x-go-name":"LastSyncTimestamp"},"filters":{"type":"object","properties":{},"description":"Filters applied on the report."},"nextPageToken":{"type":"string","description":"The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.","example":"YTBDNDk6Rjk1MmViY1FpTVpBejNFTU9lSWxzUT09OjA=","x-go-name":"NextPageToken"}},"x-go-package":"git.druva.org/druva.com/dcp-reporting-service/spec/api"},"ReportData":{"title":"ReportData ...","type":"object","additionalProperties":true,"description":"The actual data of the report. For example, if you fetch an alert report, this object contains the data of an alert.","x-go-package":"git.druva.org/druva.com/dcp-reporting-service/spec/api"},"ListEventsResponse":{"title":"ListEventsResponse (API v1)","type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/EventResponse"}}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"ListEventsResponseTwo":{"title":"ListEventsResponse (API v2)","type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/EventResponseTwo"}}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"ListEventsResponseThree":{"title":"ListEventsResponse (API v3)","type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/EventResponseThree"}}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"EventResponse":{"title":"EventResponse (API v1)","type":"object","properties":{"category":{"type":"string","description":"category represents one of the [EVENT, ALERT, AUDIT]."},"details":{"type":"string","description":"details represents the product specific event details."},"feature":{"type":"string","description":"feature represents the feature by which event was generated."},"globalID":{"type":"string","description":"globalID represents the global ID of the customer or global ID of theMSP."},"timeStamp":{"type":"integer","description":"Time at which event occurred.","format":"integer"},"productID":{"type":"integer","description":"productID represents the id of the product that generated the event.","format":"integer"},"syslogFacility":{"type":"integer","description":"Fixed values based on event source category.","format":"integer"},"syslogSeverity":{"type":"integer","description":"syslogSeverity represents the severity(0-7) of the event. <br>For Emergency 0 <br>For Alert (action must be taken immediately) 1 <br>For Critical (critical conditions) 2 <br>For Error (error conditions) 3 <br>For Warning (warning conditions) 4 <br>For Notice (normal but significant condition) 5 <br>For Informational (informational messages) 6 <br>For Debug (debug-level messages) 7"},"type":{"type":"string","description":"type represents the type of the event e.g - Login,Logout,LicenseExpired,BackupStatus etc."}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"EventResponseTwo":{"title":"EventResponse (API v2)","type":"object","properties":{"category":{"type":"string","description":"category represents one of the [EVENT, ALERT, AUDIT]."},"details":{"type":"object","description":"details represents the product specific event details. For more information on events that DCP publishes, see [Druva Cloud Platform events](/reference/druva-cloud-platform-events)."},"feature":{"type":"string","description":"feature represents the feature by which event was generated."},"globalID":{"type":"string","description":"globalID represents the global ID of the customer or global ID of theMSP."},"timeStamp":{"type":"integer","description":"Time at which event occurred.","format":"integer"},"productID":{"type":"integer","description":"productID represents the id of the product that generated the event.","format":"integer"},"syslogFacility":{"type":"integer","description":"Fixed values based on event source category.","format":"integer"},"syslogSeverity":{"type":"integer","description":"syslogSeverity represents the severity(0-7) of the event. <br>For Emergency 0 <br>For Alert (action must be taken immediately) 1 <br>For Critical (critical conditions) 2 <br>For Error (error conditions) 3 <br>For Warning (warning conditions) 4 <br>For Notice (normal but significant condition) 5 <br>For Informational (informational messages) 6 <br>For Debug (debug-level messages) 7"},"type":{"type":"string","description":"type represents the type of the event e.g - Login,Logout,LicenseExpired,BackupStatus etc."}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"EventResponseThree":{"title":"EventResponse (API v3)","type":"object","properties":{"category":{"type":"string","description":"category represents one of the [EVENT, ALERT, AUDIT]."},"details":{"type":"object","description":"details represents the product specific event details. For more information on events that DCP publishes, see [Druva Cloud Platform events](/reference/druva-cloud-platform-events-v3)."},"feature":{"type":"string","description":"feature represents the feature by which event was generated."},"globalID":{"type":"string","description":"globalID represents the global ID of the customer or global ID of theMSP."},"timeStamp":{"type":"integer","description":"Time at which event occurred.","format":"integer"},"productID":{"type":"integer","description":"productID represents the id of the product that generated the event.","format":"integer"},"syslogFacility":{"type":"integer","description":"Fixed values based on event source category.","format":"integer"},"syslogSeverity":{"type":"integer","description":"syslogSeverity represents the severity(0-7) of the event. <br>For Emergency 0 <br>For Alert (action must be taken immediately) 1 <br>For Critical (critical conditions) 2 <br>For Error (error conditions) 3 <br>For Warning (warning conditions) 4 <br>For Notice (normal but significant condition) 5 <br>For Informational (informational messages) 6 <br>For Debug (debug-level messages) 7"},"type":{"type":"string","description":"type represents the type of the event e.g - Login,Logout,LicenseExpired,BackupStatus etc."}},"x-go-package":"git.druva.org/dcp/dcp_event_manager/spec/req_resp"},"ListRolesResponse":{"title":"ListRolesResponse ...","type":"array","items":{"$ref":"#/components/schemas/ListRolesResponse_inner"}},"ChangePasswordResponse":{"title":"ChangePasswordResponse ...","type":"object","properties":{}},"CreateSafeModeActivationSettingsResponse":{"title":"CreateSafeModeActivationSettingsResponse","type":"object","description":"Response returned after safe mode activation request","properties":{"operationId":{"type":"string","description":"A unique identifier for this specific Safe Mode activation operation. Used by Support to track the request internally if a case is raised."},"status":{"type":"string","enum":["SUCCESS"],"description":"Status of the safe mode activation operation."},"warning":{"type":"string","description":"An optional warning message indicating any non-critical issues encountered during activation. For example, some specified allowedAdminIds or allowedClientCredentialIds may be disabled or deleted, but the activation proceeded successfully for the valid entries."}},"required":["operationId","status"]},"CreateAdminResponse":{"title":"CreateAdminResponse ...","type":"object","properties":{"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer","example":"axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx"},"globalAdminId":{"type":"string","description":"The unique ID associated with the admin","example":"5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7"},"adminEmail":{"type":"string","description":"The email associated with the admin","example":"sample@gmail.com"},"adminName":{"type":"string","description":"The name of the admin","example":"sample"},"role":{"type":"string","description":"The role of the admin","example":"Product"},"provisioningMode":{"type":"string","description":"The mode through which the admin was created","example":"Manual"},"adminState":{"type":"string","description":"The state of the created admin","example":"ACTIVE"},"adGuid":{"type":"string","description":"The globally unique identifier"},"disabledThroughMode":{"type":"string","description":"The mode through which the admin was disabled(Applicable only if the Admin is in DISABLED state)"},"deletionEpoch":{"type":"number","description":"The deletion epoch in case the admin is marked for deletion","format":"float","example":0},"deletionTime":{"type":"string","description":"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","format":"date-time"}}},"ListAdminsResponse":{"title":"ListAdminsResponse ...","type":"object","properties":{"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer","example":"axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx"},"totalSize":{"type":"integer","description":"The total number of admins wrt to the filters applied","example":57},"nextPageToken":{"type":"string","description":"The token to access the next page of results. This parameter will be empty for the last page of the results."},"admins":{"type":"array","items":{"$ref":"#/components/schemas/Admin"}}}},"GetAdminResponse":{"title":"GetAdminResponse ...","type":"object","properties":{"creator":{"type":"string","description":"The admin's email who created the specified admin"},"productAccessControls":{"type":"array","items":{"$ref":"#/components/schemas/GetAdminResponse_productAccessControls"}},"timezone":{"type":"string","description":"The admin's timezone"},"customerTimezone":{"type":"string","description":"The customer's timezone"},"phoneNumber":{"type":"string","description":"The admin's phone number"},"lastLoginTime":{"type":"number","description":"This is the readable time when last login was done","format":"float"},"customId":{"type":"string","description":"Null in case customId is not enabled for the customer"},"email":{"type":"string","description":"The admin's email"},"adGuid":{"type":"string","description":"The guid of AD created admin"},"adminState":{"type":"string","description":"The admin's current state","enum":["Active","Disabled"]},"disabledOnTS":{"type":"number","description":"The epoch time when the admin was disabled.","format":"float","example":1708675426},"disabledThroughMode":{"type":"string","description":"The mode through which the admin was disabled(Applicable only if the Admin is in DISABLED state)"},"provisioningMode":{"type":"string","description":"The mode through which the admin was created","enum":["Manual","AD_LDAP"]},"adMappingName":{"type":"string","description":"The mapping name for the AD created admin"},"adMappingId":{"type":"integer","description":"The mapping ID for the AD created admin"},"globalAdminId":{"type":"string","description":"The unique ID associated with the admin"},"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer"},"allowPasswordIfSAML":{"type":"boolean","description":"For customer with SAML auth scheme"},"lastLoginDevice":{"type":"string","description":"This is the Device/OS through which the last login was done"},"nextPasswordChangeTime":{"type":"number","description":"Populated depending upon the max password age defined in the policy","format":"float"},"role":{"type":"string","description":"The role associated with the admin"},"adminName":{"type":"string","description":"The name of the admin"},"customerSFDCId":{"type":"array","description":"List of SFDC Ids","items":{"type":"string"}},"ipAddress":{"type":"string","description":"This is the admin's current login IP address"},"additionalProperties":{"$ref":"#/components/schemas/GetAdminResponse_additionalProperties"}}},"UpdateAdminResponse":{"title":"UpdateAdminResponse ...","type":"object","properties":{"adminEmail":{"type":"string","description":"The email of the admin","example":"sample@gmail.com"},"adminName":{"type":"string","description":"The name of the admin","example":"sample"},"adminState":{"type":"string","description":"The new modified state of the admin","example":"ACTIVE"},"timezone":{"type":"string","description":"The timezone of the admin","example":"UTC"},"globalAdminId":{"type":"string","description":"The unique ID associated with the admin","example":"5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7"},"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer","example":"axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx"},"adGuid":{"type":"string","description":"The globally unique identifier"},"role":{"type":"integer","description":"The role ID of the admin","example":2},"provisioningMode":{"type":"string","description":"The mode through which the admin was created","example":"Manual"}}},"UpdateAdminRoleResponse":{"title":"UpdateAdminRoleResponse ...","type":"object","properties":{"globalAdminId":{"type":"string","description":"The unique ID associated with the admin","example":"5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7"},"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer","example":"axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx"},"adminEmail":{"type":"string","description":"The email of the admin","example":"sample@gmail.com"},"adminName":{"type":"string","description":"The name of the admin","example":"sample"},"role":{"type":"string","description":"The role of the admin","example":"Product"},"productAccessControls":{"type":"array","description":"Product-level access control configuration with detailed rights and permissions","items":{"$ref":"#/components/schemas/GetAdminResponse_productAccessControls"}}}},"DeleteAdminResponse":{"title":"DeleteAdminResponse ...","type":"object","properties":{"adminEmail":{"type":"string","description":"The email of the deleted admin","example":"sample@gmail.com"},"adminState":{"type":"string","description":"The state of the before its deletion","example":"ACTIVE"},"globalAdminId":{"type":"string","description":"The unique ID associated with the admin before its deletion","example":"5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7"},"globalCustomerId":{"type":"string","description":"The unique ID associated with the customer before its deletion","example":"axexxxxx-1xxx-4xxx-8xxx-5xxxxxxxxxxx"},"adGuid":{"type":"string","description":"The globally unique identifier"},"role":{"type":"integer","description":"The role assoiated the admin before its deletion","example":2},"provisioningMode":{"type":"string","description":"The mode through which the admin was initially created","example":"Manual"}}},"Filters":{"title":"Filters ...","type":"object","properties":{"lastLogin":{"type":"number","description":"Specify the last login time on which the admins has to be filtered","format":"float"},"role":{"type":"number","description":"Specify the role ID on which the admins has to be filtered","enum":[2,1]},"productId":{"type":"array","description":"Specify the productID on which the admins has to be filtered","items":{"type":"number","enum":[4097,8193,12289]}},"adminState":{"type":"array","description":"Specify the list of admin states on which the admins has to be filtered","items":{"type":"string","enum":["ACTIVE","DISABLED"]}},"provisioningMode":{"type":"array","description":"Specify the list of creation modes on which the admins has to be filtered","items":{"type":"string","enum":["Manual","AD_LDAP"]}}},"readOnly":true},"Admin":{"title":"Admin ...","type":"object","properties":{"globalAdminId":{"type":"string","description":"The unique ID associated with the admin","example":"5bxxxxxx-exxx-xxex-bxxx-e00xxx98xxxx-xxx7"},"adminEmail":{"type":"string","description":"The email associated with the admin","example":"sample@gmail.com"},"adminName":{"type":"string","description":"The name of the admin","example":"sample"},"lastLogin":{"type":"number","description":"The last time the admin had logged-in","format":"float","example":1703570381.19192},"role":{"type":"string","description":"The role associated with the admin","example":"Druva Cloud"},"provisioningMode":{"type":"string","description":"The mode through which the admin was created","example":"AD_LDAP"},"adminState":{"type":"string","description":"The current state of the admin","example":"DISABLED"},"disabledThroughMode":{"type":"string","description":"The mode through which the admin was disabled(Applicable only if the Admin is in DISABLED state)","example":"Manual"},"adGuid":{"type":"string","description":"The globally unique identifier"},"deletionEpoch":{"type":"number","description":"The deletion epoch in case the admin is marked for deletion","format":"float","example":0},"deletionTime":{"type":"string","description":"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","format":"date-time"},"customId":{"type":"string","description":"Null in case customId is not enabled for the customer"},"adMappingId":{"type":"integer","description":"The mapping ID for the AD created admin","example":38},"disabledOnTS":{"type":"number","description":"The epoch time when the admin was disabled.","format":"float","example":1708675426}}},"reportingversionreportsreportID_filters_filterBy":{"type":"object","properties":{"fieldName":{"type":"string","description":"Specify the name of the filter. TBD","example":"deleteRequestID"},"operator":{"type":"string","description":"The operators that are supported for the filter are - EQUAL, NOTEQUAL, CONTAINS, LT (less-than), LTE (less-than-or-equal), GT (greater-than), GTE (greater-than-or-equal).","example":"EQUAL","enum":["EQUAL","GT","GTE","LT","LTE","CONTAINS","NOTEQUAL"]},"value":{"description":"Specify the value of the filter applied to the report.","example":"11ef158d-929c-4841-ab83-0ca4179c1420","oneOf":[{"type":"string","description":"string"},{"type":"integer","description":"integer"},{"type":"array","description":"array of strings","items":{"type":"string"}},{"type":"array","description":"array of integers","items":{"type":"integer"}}]}}},"reportingversionreportsreportID_filters":{"type":"object","properties":{"pageSize":{"type":"integer","description":"Specify the maximum number of records that should returned in a response. Maximum limit is 500 records. Default pageSize is 100.","default":100},"filterBy":{"type":"array","description":"Select the filters to be applied to the report. If you do not specify a date filter, the lastUpdatedTime filter is set to 1 day by default.","items":{"$ref":"#/components/schemas/reportingversionreportsreportID_filters_filterBy"}}}},"reports_reportID_body":{"type":"object","properties":{"filters":{"$ref":"#/components/schemas/reportingversionreportsreportID_filters"},"pageToken":{"type":"string","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","example":""}}},"consolev1admins_productAccessControls_itemList":{"type":"object","properties":{"itemID":{"type":"integer","description":"Group id of the site the admin should be granted access"},"itemName":{"type":"string","description":"Group name of the site the admin should be granted access"}}},"consolev1admins_productAccessControls_accessControls":{"type":"object","properties":{"collectionName":{"type":"string","description":"The name of the site/organization or Workloads/Profiles/Legal Hold Types for which you want to allow admin to access","example":"Default","default":"Default"},"collectionID":{"type":"integer","description":"The id of the site/organization or Workloads/Profiles/Legal Hold Types for which you want to allow admin to access","example":4,"default":4},"resource":{"type":"string","description":"Resource can be Organization / Groups or Workloads/Profiles/Legal Hold Types","example":"Profiles","default":"Profiles"},"itemList":{"type":"array","description":"Details of group of which admin access is provided","example":[],"items":{"$ref":"#/components/schemas/consolev1admins_productAccessControls_itemList"},"default":[]}}},"consolev1admins_productAccessControls_products":{"type":"object","properties":{"productID":{"type":"integer","description":"Possible values are 8193 - Insync, 12289 - Enterprise Workloads","example":8193,"default":8193},"productRole":{"type":"string","description":"The role of the administrator you want to create. Administrator role types are available in the Cloud Console.\n```\nPossible Enterprise Workloads roles are :\n- Cloud Administrator\n- Cloud Administrator (View-only)\n- Data Protection Officer\n- Organization Administrator\n- Organization Administrator (View-only)\n- Group Administrator\n- Group Administrator (View-only)\n\nPossible inSync roles are :\n- Cloud Admin\n- Data Protection Officer\n- Help Desk Admin\n- Legal Admin\n- Profile Admin\n- Sensitive Data Governance Admin\n- View Only Admin\n- Workload Admin\n```\n:fa-info-circle: You can also assign any custom role that is created in the product console.\n","example":"Profile Admin","default":"Profile Admin"},"accessControls":{"type":"array","description":"A list containing data about the sites and groups to which admin needs to be granted access","items":{"$ref":"#/components/schemas/consolev1admins_productAccessControls_accessControls"}}}},"consolev1admins_productAccessControls":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/consolev1admins_productAccessControls_products"}}},"description":"Specify this if you are creating a 'Product' administrator."},"adminRole_productAccessControls_products":{"type":"object","properties":{"productID":{"type":"integer","description":"Possible values are 8193 - Insync, 12289 - Enterprise Workloads","example":8193},"productRole":{"type":"string","description":"The role of the administrator. Administrator role types are available in the Cloud Console.\n```\nPossible Enterprise Workloads roles are :\n- Cloud Administrator\n- Cloud Administrator (View-only)\n- Data Protection Officer\n- Organization Administrator\n- Organization Administrator (View-only)\n- Group Administrator\n- Group Administrator (View-only)\n\nPossible inSync roles are :\n- Cloud Admin\n- Data Protection Officer\n- Help Desk Admin\n- Legal Admin\n- Profile Admin\n- Sensitive Data Governance Admin\n- View Only Admin\n- Workload Admin\n```\n:fa-info-circle: You can also assign any custom role that is created in the product console.\n","example":"Profile Admin"},"accessControl":{"type":"array","description":"A list containing data about the sites and groups to which admin needs to be granted access","items":{"$ref":"#/components/schemas/consolev1admins_productAccessControls_accessControls"}}}},"adminRole_productAccessControls":{"type":"array","description":"Product-level access control configuration for role updates.","items":{"$ref":"#/components/schemas/adminRole_productAccessControls_products"}},"v1_admins_body":{"required":["adminEmail","adminName","provisioningMode","role","timezone"],"type":"object","properties":{"adminEmail":{"type":"string","description":"The email address of the administrator you want to create.","example":"sample@gmail.com"},"adminName":{"type":"string","description":"The name of the administrator you want to create.","example":"sample"},"role":{"type":"string","description":"Select the role of the administrator.\n- 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.\n- Product - Product administrator can perform all core product-related activities such as configuring, managing, and monitoring.\n","enum":["Product","Druva Cloud"]},"timezone":{"type":"string","description":"Specify the timezone of the administrator.","example":"UTC"},"productAccessControls":{"$ref":"#/components/schemas/consolev1admins_productAccessControls"},"provisioningMode":{"type":"string","description":"The mode through which the admin is being created.","readOnly":true,"default":"Manual","enum":["Manual","AD_LDAP"]},"adminState":{"type":"string","description":"The state of the admin to be created.","readOnly":true,"default":"ACTIVE","enum":["ACTIVE","DISABLED"]},"adGuid":{"type":"string","description":"The globally unique identifier","readOnly":true},"adMappingId":{"type":"integer","description":"The unique AD Mapping ID.","readOnly":true,"example":17890},"adMappingName":{"type":"string","description":"The AD Mapping name.","readOnly":true,"example":"mappingName"},"druvaDomainLegalConsent":{"type":"boolean","description":"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":false,"default":false}}},"admins_globalAdminID_body":{"type":"object","properties":{"adminName":{"type":"string","description":"The name of the administrator.","example":"sample"},"timezone":{"type":"string","description":"The timezone of the administrator. Use IANA timezone format (e.g., UTC, Africa/Abidjan, America/Detroit, Asia/Dubai).","example":"UTC"},"adminState":{"type":"string","description":"Specify the new state of the admin.","enum":["ACTIVE","DISABLED"]}}},"admins_globalAdminID_role_body":{"required":["role"],"type":"object","properties":{"role":{"type":"string","description":"Select the role of the administrator.\n- 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.\n- Product - Product administrator can perform all core product-related activities such as configuring, managing, and monitoring.\n","enum":["Product","Druva Cloud"]},"productAccessControls":{"$ref":"#/components/schemas/adminRole_productAccessControls"}}},"admin_password_body":{"required":["adminEmail","currentPassword","newPassword"],"type":"object","properties":{"adminEmail":{"type":"string","description":"The email address of the administrator whose password you want to change.","example":"sample@gmail.com"},"currentPassword":{"type":"string","description":"The administrator's current password.","example":"samplePassword!2#4"},"newPassword":{"type":"string","description":"The administrator's new password that you want to set.","example":"NewSamplePassword@@Druva$"}}},"ListRolesResponse_inner":{"type":"object","properties":{"role":{"type":"string","description":"The role of the administrator you want to create. \n```\nPossible Enterprise Workloads roles are :\n- Cloud Administrator\n- Cloud Administrator (View-only)\n- Data Protection Officer\n- Organization Administrator\n- Organization Administrator (View-only)\n- Group Administrator\n- Group Administrator (View-only)\nPossible inSync roles are :\n- Cloud Admin\n- Data Protection Officer\n- Help Desk Admin\n- Legal Admin\n- Profile Admin\n- Sensitive Data Governance Admin\n- View Only Admin\n- Workload Admin\n```\n","example":"Profile Admin"},"accessControl":{"type":"array","items":{"type":"object","properties":{"resource":{"type":"string","description":"Resource can be Organization or Groups for Enterprise Workloads. Resource can be Workload, Profiles or Legal Hold Types for Endpoint and SaaS Apps.","example":"Workloads"},"collections":{"type":"array","items":{"type":"object","properties":{"collectionID":{"type":"integer","description":"The id of the resource for which you want to allow admin to access.\n- The id of the site or organization for Enterprise Workloads\n- The id of the Workload or Profile or Legal Hold Type for for Endpoints and SaaS Apps\n","example":1},"collectionName":{"type":"string","description":"The name of the resource for which you want to allow admin to access.\n- The name of the site or organization for Enterprise Workloads\n- The name of the Workload or Profile or Legal Hold Type for for Endpoints and SaaS Apps\n","example":"Endpoints"},"itemList":{"type":"array","description":"Details of group of which admin access is provided","items":{"type":"object","properties":{"itemID":{"type":"integer","description":"Group id of the site the admin should be granted access"},"itemName":{"type":"string","description":"Group name of the site the admin should be granted access"}}},"default":[]}},"description":"Details of the resource for which administrator access is provided -\n- Organization or site for Enterprise Workloads\n- Workloads or Profiles or Legal Hold Types for Endpoints and SaaS Apps\n"}}}}}}},"GetAdminResponse_collection":{"type":"object","properties":{"fullAccess":{"type":"boolean","description":"It describes whether the admin has full access to above specified resource or not"},"type":{"type":"string","description":"Type can be Groups / Sites for Enterprise Workloads, or Workloads/Profiles/Legal Hold Types for Insync"},"itemList":{"type":"array","items":{"$ref":"#/components/schemas/consolev1admins_productAccessControls_itemList"},"default":[]},"name":{"type":"string","description":"The name of the site/organization or Workloads/Profiles/Legal Hold Types for which your admin has access"},"collectionID":{"type":"integer","description":"The id of the site/organization or Workloads/Profiles/Legal Hold Types for which your admin has access"}}},"GetAdminResponse_accessControl":{"type":"object","properties":{"resource":{"type":"string","description":"Resource can be Organization / Groups for Enterprise Workloads, or Workloads/Profiles/Legal Hold Types for Insync"},"fullAccess":{"type":"boolean","description":"It describes whether the admin has full access to above specified resource or not"},"collection":{"type":"array","items":{"$ref":"#/components/schemas/GetAdminResponse_collection"}}}},"GetAdminResponse_rights":{"type":"object","properties":{"right":{"type":"string","description":"Name of the right which is to be provided"},"allotted":{"type":"boolean","description":"Is the above right mentioned allotted or not"}},"description":"List of rights which are provided to the admin under the specified category. Like\n- Configure Backup\n- Perform Backup\n- Delete Devices\netc\n"},"GetAdminResponse_rights_1":{"type":"object","properties":{"category":{"type":"string","description":"Name of the category to which the rights depend or are listed under. Like\n- Backup And Restore Management\n- Server Management\netc\n"},"rights":{"type":"array","items":{"$ref":"#/components/schemas/GetAdminResponse_rights"}}}},"GetAdminResponse_consoleRights_customer_IPFencing":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over IPFencing"},"write":{"type":"boolean","description":"This describes whether write is allowed over IPFencing"}},"description":"The IPFencing policy empowers you to restrict access to the Druva Cloud Platform Console from outside your corporate network. It helps you control, monitor, and protect your data from unauthorized access from outside the organization."},"GetAdminResponse_consoleRights_customer_passwordPolicy":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over passwordPolicy"},"write":{"type":"boolean","description":"This describes whether write is allowed over passwordPolicy"}},"description":"A Password Policy is a set of rules that encourage the use of strong passwords for ensuring added data security. inSync supports password policies for the users and administrators."},"GetAdminResponse_consoleRights_customer_SSOSettings":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over SSOSettings"},"write":{"type":"boolean","description":"This describes whether write is allowed over SSOSettings"}},"description":"Single Sign-On (SSO) is a mechanism that allows users to access multiple resources using a single action of authentication and authorization."},"GetAdminResponse_consoleRights_customer":{"type":"object","properties":{"IPFencing":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_customer_IPFencing"},"passwordPolicy":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_customer_passwordPolicy"},"SSOSettings":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_customer_SSOSettings"}}},"GetAdminResponse_consoleRights_adminSelf_name":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over name"},"write":{"type":"boolean","description":"This describes whether write is allowed over name"}},"description":"This is attribute of admin for displaying it's identity"},"GetAdminResponse_consoleRights_adminSelf_timeZone":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over timeZone"},"write":{"type":"boolean","description":"This describes whether write is allowed over timeZone"}},"description":"This is the timezone of the admin who has logged in or using the api"},"GetAdminResponse_consoleRights_adminSelf_country":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over country"},"write":{"type":"boolean","description":"This describes whether write is allowed over country"}},"description":"This is the country of the admin who has logged in or using the api"},"GetAdminResponse_consoleRights_adminSelf":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminSelf_name"},"timeZone":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminSelf_timeZone"},"country":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminSelf_country"},"changePassword":{"type":"boolean","description":"This describes whether the admin is allowed to change password or not"}}},"GetAdminResponse_consoleRights_adminOthers_timeZone":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over timeZone"},"write":{"type":"boolean","description":"This describes whether write is allowed over timeZone"}},"description":"This describes whether write is allowed over timeZone"},"GetAdminResponse_consoleRights_adminOthers_country":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over country"},"write":{"type":"boolean","description":"This describes whether write is allowed over country"}},"description":"This describes whether write is allowed over country"},"GetAdminResponse_consoleRights_adminOthers_role":{"type":"object","properties":{"read":{"type":"boolean","description":"This describes whether read is allowed over role"},"write":{"type":"boolean","description":"This describes whether write is allowed over role"}},"description":"This describes the role of logged admin whether he has rights to modify role of other admin or not"},"GetAdminResponse_consoleRights_adminOthers":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminSelf_name"},"timeZone":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminOthers_timeZone"},"country":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminOthers_country"},"role":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminOthers_role"},"passwordReset":{"type":"boolean","description":"This describes whether passwordReset is allowed or not"},"createAdmin":{"type":"boolean","description":"This describes whether this admin is allowed to create a admin or not"},"deleteAdmin":{"type":"boolean","description":"This describes whether this admin is allowed to delete a admin or not"}}},"GetAdminResponse_consoleRights":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_customer"},"adminSelf":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminSelf"},"adminOthers":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights_adminOthers"}},"description":"Console rights define which functionalities of DCP console should be accessible to admin. For example, it tells whether this admin is allowed to create other admins using DCP UI."},"GetAdminResponse_productAccessControls":{"type":"object","properties":{"accessControl":{"type":"array","items":{"$ref":"#/components/schemas/GetAdminResponse_accessControl"}},"product":{"type":"string","description":"The name of the licensed product"},"roleDetailsURL":{"type":"string","description":"This url redirects you to the product page where it describes the role details for the admin"},"description":{"type":"string","description":"Description of the role of that particular admin"},"rights":{"type":"array","description":"These rights describe the functionalities of product should be accessible to admin. For example, it tells whether this admin is allowed to take backup of user data.","items":{"$ref":"#/components/schemas/GetAdminResponse_rights_1"}},"editAllowed":{"type":"boolean","description":"This describes that whether the admin has edit access or not"},"role":{"type":"string","description":"This describes the role of the admin"},"consoleRights":{"$ref":"#/components/schemas/GetAdminResponse_consoleRights"},"productId":{"type":"integer","description":"The unique ID of the licensed product"}}},"GetAdminResponse_additionalProperties_allowedCustomerContextOperations":{"type":"object","properties":{"editAdmin":{"type":"boolean"},"resetPassword":{"type":"boolean"},"deleteAdmin":{"type":"boolean"},"changePassword":{"type":"boolean"}},"description":"Depicts the admin permissions","writeOnly":true},"GetAdminResponse_additionalProperties_productIds":{"type":"object","properties":{"adminId":{"type":"integer","description":"The admin ID"},"customerId":{"type":"integer","description":"The customer ID"},"productId":{"type":"integer","description":"The unique ID of the associated product"}}},"GetAdminResponse_additionalProperties_rights":{"type":"object","properties":{"accountDetails":{"type":"array","description":"List of product IDs populated","items":{"type":"integer"}},"adminManagement":{"type":"array","description":"List of product IDs populated","items":{"type":"integer"}}},"writeOnly":true},"GetAdminResponse_additionalProperties":{"type":"object","properties":{"customerName":{"type":"string","description":"The name of the customer to which the admin is associated","writeOnly":true},"allowedCustomerContextOperations":{"$ref":"#/components/schemas/GetAdminResponse_additionalProperties_allowedCustomerContextOperations"},"accountDeletion":{"type":"boolean","description":"Always false","writeOnly":true},"deletionEpoch":{"type":"number","description":"The deletion epoch in case the admin is marked for deletion","format":"float","writeOnly":true},"productIds":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/GetAdminResponse_additionalProperties_productIds"}},"deletionTime":{"type":"string","description":"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","writeOnly":true},"isReadOnly":{"type":"boolean","description":"True in case of MSP admin","writeOnly":true},"enableAlerts":{"type":"boolean","description":"True if alerts are enabled","writeOnly":true},"deploymentId":{"type":"integer","description":"The unique ID associated with AWS region","writeOnly":true},"customerAuthType":{"type":"integer","description":"The customer's authentication scheme. 1 - Password 2 - Saml Token","writeOnly":true},"accountUpgrade":{"type":"boolean","description":"Always false","writeOnly":true},"lastLoginEpoch":{"type":"number","description":"The admin's last login time in epoch","format":"float","writeOnly":true},"rights":{"$ref":"#/components/schemas/GetAdminResponse_additionalProperties_rights"},"lastLoginIPAddress":{"type":"string","description":"This is the admin's last login IP address","writeOnly":true},"logoutURL":{"type":"string","writeOnly":true},"lastLogin":{"type":"string","description":"The time at which the admin had previously logged-in. The time is in the UTC time zone. Example - 2024-01-04T09:06:02.191Z","writeOnly":true},"intercomUserHash":{"type":"string","description":"The intercom user hash generated for admin","writeOnly":true}}}},"securitySchemes":{"BearerAuth":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apis.druva.com/token","scopes":{"read":"Grants read access"}}}},"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}