Subclient Email Policy Association

Select

SaaS

Customer Managed

This operation returns information about mailboxes or auto discover association depending on discoveryType.

Path Parameters

subclientId string required

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

environmentType integer
associations object[]
emailStatus integer
discoverType integer
pagingInfo object
totalRecords integer
policies object
emailPolicies object[]
policyType integer
detail object
emailPolicy object
emailPolicyType integer
policyEntity object
policyId integer
policyName string
databaseInfo object
databaseName string
exchangeServer string
adGroupsInfo object
adGroupName string
userMailBoxInfo object
aliasName string
numberOfEmails integer
mailBoxType integer
databaseName string
displayName string
mailboxSize integer
smtpAdrress string
isAutoDiscoveredUser boolean
msExchRecipientTypeDetails integer
exchangeVersion integer
exchangeServer string
created object
time integer
lastArchiveJobRanTime object
time integer
modified object
time integer
user object
_type_ integer
userGUID string
additionalOptions object
enableAutoDiscovery boolean
subclientEntity object
plan object
_type_ integer
planName string
planId integer
stats object
indexCreationTime integer
ciCount integer
numberOfItems integer
lastCiJobRanTime integer
lastArchiveJobRanTime integer
appArchiveSize integer
emailCount integer

{
  "environmentType": 0,
  "associations": [
    {
      "emailStatus": 0,
      "discoverType": 0,
      "pagingInfo": {
        "totalRecords": 0
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 0,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 0
              }
            },
            "policyEntity": {
              "policyId": 0,
              "policyName": "string"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "string",
        "exchangeServer": "string"
      },
      "adGroupsInfo": {
        "adGroupName": "string"
      },
      "userMailBoxInfo": {
        "aliasName": "string",
        "numberOfEmails": 0,
        "mailBoxType": 0,
        "databaseName": "string",
        "displayName": "string",
        "mailboxSize": 0,
        "smtpAdrress": "string",
        "isAutoDiscoveredUser": true,
        "msExchRecipientTypeDetails": 0,
        "exchangeVersion": 0,
        "exchangeServer": "string",
        "created": {
          "time": 0
        },
        "lastArchiveJobRanTime": {
          "time": 0
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 0,
          "userGUID": "string"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": true
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 0,
        "planName": "string",
        "planId": 0
      }
    }
  ],
  "stats": {
    "indexCreationTime": 0,
    "ciCount": 0,
    "numberOfItems": 0,
    "lastCiJobRanTime": 0,
    "lastArchiveJobRanTime": 0,
    "appArchiveSize": 0,
    "emailCount": 0
  }
}

{
  "environmentType": 4,
  "associations": [
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {},
      "userMailBoxInfo": {
        "aliasName": "1Manoj",
        "numberOfEmails": 7,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "1Manoj",
        "mailboxSize": 147690,
        "smtpAdrress": "1Manoj@commvault365.onmicrosoft.com",
        "isAutoDiscoveredUser": false,
        "msExchRecipientTypeDetails": 36,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612391378
        },
        "lastArchiveJobRanTime": {
          "time": 1613077587
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "4226AE8AXD94AX4280X870DX6AAD715F7D5B"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": false
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    },
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {},
      "userMailBoxInfo": {
        "aliasName": "1ManojPerfexPureAzure",
        "numberOfEmails": 1,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "1ManojPerfexPureAzure",
        "mailboxSize": 30541,
        "smtpAdrress": "1ManojPerfexPureAzure@commvault365.onmicrosoft.com",
        "isAutoDiscoveredUser": false,
        "msExchRecipientTypeDetails": 36,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612391378
        },
        "lastArchiveJobRanTime": {
          "time": 1613077591
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "E6787EE4X4C21X43D8X960FX8FD7E82C3BD7"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": false
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    },
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {},
      "userMailBoxInfo": {
        "aliasName": "1ManojPerfexUserSynchedToAzure",
        "numberOfEmails": 1,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "1ManojPerfexUserSynchedToAzure",
        "mailboxSize": 30816,
        "smtpAdrress": "1ManojPerfexUserSynchedToAzure@commvault365.onmicrosoft.com",
        "isAutoDiscoveredUser": false,
        "msExchRecipientTypeDetails": 36,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612455286
        },
        "lastArchiveJobRanTime": {
          "time": 1613077585
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "0B86D204X544EX4D77X8F63X1B76CDB75C46"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": false
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    },
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {
        "adGroupName": ""
      },
      "userMailBoxInfo": {
        "aliasName": "ManojGlobAdminNoLicBasicBlocked",
        "numberOfEmails": 149793,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "ManojGlobAdminNoLicBasicBlocked",
        "mailboxSize": 27106454122,
        "smtpAdrress": "ManojGlobAdminNoLicBasicBlocked@commvault365.onmicrosoft.com",
        "isAutoDiscoveredUser": true,
        "msExchRecipientTypeDetails": 3,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612455558
        },
        "lastArchiveJobRanTime": {
          "time": 1613077510
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "91562463XF740X4DA1XBC1AX4F3C055115AF"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": true
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    },
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {
        "adGroupName": ""
      },
      "userMailBoxInfo": {
        "aliasName": "sp15onlymb2",
        "numberOfEmails": 6212,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "sp15onlymb2",
        "mailboxSize": 5640381674,
        "smtpAdrress": "sp15onlymb2@commvault365.onmicrosoft.com",
        "isAutoDiscoveredUser": true,
        "msExchRecipientTypeDetails": 1,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612455558
        },
        "lastArchiveJobRanTime": {
          "time": 1613077583
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "D92F5C3BXFA97X48D9X9CE8X66717DF507C3"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": true
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    },
    {
      "emailStatus": 0,
      "discoverType": 1,
      "pagingInfo": {
        "totalRecords": 6
      },
      "policies": {
        "emailPolicies": [
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 1
              }
            },
            "policyEntity": {
              "policyId": 2189,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox archiving policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 3
              }
            },
            "policyEntity": {
              "policyId": 2190,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox retention policy"
            }
          },
          {
            "policyType": 1,
            "detail": {
              "emailPolicy": {
                "emailPolicyType": 2
              }
            },
            "policyEntity": {
              "policyId": 2191,
              "policyName": "newoffice365plan_3rd feb Office 365 Mailbox cleanup policy"
            }
          }
        ]
      },
      "databaseInfo": {
        "databaseName": "",
        "exchangeServer": ""
      },
      "adGroupsInfo": {},
      "userMailBoxInfo": {
        "aliasName": "herbrewmb1",
        "numberOfEmails": 79877,
        "mailBoxType": 1,
        "databaseName": "",
        "displayName": "\"מפוצצים 10 גשרים ברחבי ארץ ישראל; ני ליל הגשרים\" - אנשי הפלמ\"ח",
        "mailboxSize": 6979157677,
        "smtpAdrress": "herbrewmb1@commvault365.com",
        "isAutoDiscoveredUser": false,
        "msExchRecipientTypeDetails": 3,
        "exchangeVersion": 2,
        "exchangeServer": "",
        "created": {
          "time": 1612379832
        },
        "lastArchiveJobRanTime": {
          "time": 1613077588
        },
        "modified": {
          "time": 0
        },
        "user": {
          "_type_": 13,
          "userGUID": "4BC960F9X58C7X4567X9637X8EEF1476288A"
        }
      },
      "additionalOptions": {
        "enableAutoDiscovery": false
      },
      "subclientEntity": {},
      "plan": {
        "_type_": 158,
        "planName": "newoffice365plan_3rd feb",
        "planId": 392
      }
    }
  ],
  "stats": {
    "indexCreationTime": 1612991284,
    "ciCount": 0,
    "numberOfItems": 6,
    "lastCiJobRanTime": 0,
    "lastArchiveJobRanTime": 1613077687,
    "appArchiveSize": 40601381172,
    "emailCount": 244393
  }
}

GET /subclient/:subclientid/emailpolicyassociation

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

subclientId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Subclient/:subclientId/EmailPolicyAssociation' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Subclient Email Policy Association​

Authorization

Request

Subclient Email Policy Association