Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

SystemUserRoleResponse

Property	Description	Type
description	Description of the system user role	string
hidden	Hidden status of the system user role Roles Manage permission is required to access hidden roles	boolean
permissions		Permissions
Permissions properties Property Description Type accountingSettings AccountingSettings AccountingSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean accounts Accounts Accounts properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean accountsModule AccountsModule AccountsModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean accountsModuleActualData AccountsModuleActualData AccountsModuleActualData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean accrualSettings AccrualSettings AccrualSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean view boolean allInstalledReports AllInstalledReports AllInstalledReports properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean applicationSettings ApplicationSettings ApplicationSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean approveBills ApproveBills ApproveBills properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string baselineEngine BaselineEngine BaselineEngine properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean billCAPture BillCAPture BillCAPture properties Property Description Type create boolean description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean billListAdministrator BillListAdministrator BillListAdministrator properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string billWorkflowSettings BillWorkflowSettings BillWorkflowSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean billsAndBatches BillsAndBatches BillsAndBatches properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean billsModule BillsModule BillsModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean budgetsAndBudgetVersions BudgetsAndBudgetVersions BudgetsAndBudgetVersions properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingAndMeterGroups BuildingAndMeterGroups BuildingAndMeterGroups properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string buildingsAndMetersModule BuildingsAndMetersModule BuildingsAndMetersModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleActualData BuildingsAndMetersModuleActualData BuildingsAndMetersModuleActualData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleBudgets BuildingsAndMetersModuleBudgets BuildingsAndMetersModuleBudgets properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleCalendarizedData BuildingsAndMetersModuleCalendarizedData BuildingsAndMetersModuleCalendarizedData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleMeterIntervalData BuildingsAndMetersModuleMeterIntervalData BuildingsAndMetersModuleMeterIntervalData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleNormalizedData BuildingsAndMetersModuleNormalizedData BuildingsAndMetersModuleNormalizedData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleSavings BuildingsAndMetersModuleSavings BuildingsAndMetersModuleSavings properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndMetersModuleSustainability BuildingsAndMetersModuleSustainability BuildingsAndMetersModuleSustainability properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean buildingsAndOrganizations BuildingsAndOrganizations BuildingsAndOrganizations properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean chargebackReversals ChargebackReversals ChargebackReversals properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string chargebacks Chargebacks Chargebacks properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean chargebacksModule ChargebacksModule ChargebacksModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean collections Collections Collections properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean costCenters CostCenters CostCenters properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean dashboardAdministrator DashboardAdministrator DashboardAdministrator properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string dashboardAndMapsModule DashboardAndMapsModule DashboardAndMapsModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean distributedReportsSettings DistributedReportsSettings DistributedReportsSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string emissionsSources EmissionsSources EmissionsSources properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean emissionsSourcesModule EmissionsSourcesModule EmissionsSourcesModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean energyManagerModule EnergyManagerModule EnergyManagerModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean energystarSubmissions ENERGYSTARSubmissions ENERGYSTARSubmissions properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean exportBills ExportBills ExportBills properties Property Description Type delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean exportHold ExportHold ExportHold properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string facilityProjects FacilityProjects FacilityProjects properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean flaggedItems FlaggedItems FlaggedItems properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean globalCostAvoidanceSettings GlobalCostAvoidanceSettings GlobalCostAvoidanceSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean greenhouseGasAdministrator GreenhouseGasAdministrator GreenhouseGasAdministrator properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string groupsAndBenchmarksModule GroupsAndBenchmarksModule GroupsAndBenchmarksModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean intervalData IntervalData IntervalData properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string intervalDataAnalysis IntervalDataAnalysis IntervalDataAnalysis properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean intervalDataRollup IntervalDataRollup IntervalDataRollup properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean licenseFeatureAccountingExport LicenseFeatureAccountingExport LicenseFeatureAccountingExport properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureAccrualBills LicenseFeatureAccrualBills LicenseFeatureAccrualBills properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureBillCAPtureManagedServices LicenseFeatureBillCAPtureManagedServices LicenseFeatureBillCAPtureManagedServices properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureBillCapturePostPay LicenseFeatureBillCapturePostPay LicenseFeatureBillCapturePostPay properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureBillCapturePrePay LicenseFeatureBillCapturePrePay LicenseFeatureBillCapturePrePay properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureBudgets LicenseFeatureBudgets LicenseFeatureBudgets properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureCarbonHub LicenseFeatureCarbonHub LicenseFeatureCarbonHub properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureChargebacks LicenseFeatureChargebacks LicenseFeatureChargebacks properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureCostAvoidance LicenseFeatureCostAvoidance LicenseFeatureCostAvoidance properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureCustomBenchmarks LicenseFeatureCustomBenchmarks LicenseFeatureCustomBenchmarks properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureEnergyCAPPayments LicenseFeatureEnergyCAPPayments LicenseFeatureEnergyCAPPayments properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureGhg LicenseFeatureGhg LicenseFeatureGhg properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureGhgPremium LicenseFeatureGhgPremium LicenseFeatureGhgPremium properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureIntervalData LicenseFeatureIntervalData LicenseFeatureIntervalData properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureIntervalDataAnalysis LicenseFeatureIntervalDataAnalysis LicenseFeatureIntervalDataAnalysis properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureLegacyGHG LicenseFeatureLegacyGHG LicenseFeatureLegacyGHG properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureNonEnglishBills LicenseFeatureNonEnglishBills LicenseFeatureNonEnglishBills properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureReportDesigner LicenseFeatureReportDesigner LicenseFeatureReportDesigner properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureReportDistribution LicenseFeatureReportDistribution LicenseFeatureReportDistribution properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureUIdI LicenseFeatureUIDI LicenseFeatureUIDI properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean licenseFeatureVendorManagementServices LicenseFeatureVendorManagementServices LicenseFeatureVendorManagementServices properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean manuallyAdjustSavings ManuallyAdjustSavings ManuallyAdjustSavings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean meterSavingsSettings MeterSavingsSettings MeterSavingsSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean meters Meters Meters properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean moveAccountsBetweenVendors MoveAccountsBetweenVendors MoveAccountsBetweenVendors properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string moveExistingBills MoveExistingBills MoveExistingBills properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string normalizationSettings NormalizationSettings NormalizationSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean publicDashboardsOrMaps PublicDashboardsOrMaps PublicDashboardsOrMaps properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string rateSchedules RateSchedules RateSchedules properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string records Records Records properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean recordsListAdministrator RecordsListAdministrator RecordsListAdministrator properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string recordsModule RecordsModule RecordsModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean reportAdministrator ReportAdministrator ReportAdministrator properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string reportGroups ReportGroups ReportGroups properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string reports Reports Reports properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean reportsModule ReportsModule ReportsModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean resetUserPasswords ResetUserPasswords ResetUserPasswords properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string roles Roles Roles properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string savingsAdjustments SavingsAdjustments SavingsAdjustments properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean savingsEngine SavingsEngine SavingsEngine properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string run boolean sendNotifications SendNotifications SendNotifications properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string sharedBillLists SharedBillLists SharedBillLists properties Property Description Type create boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean sharedDashboardsOrMaps SharedDashboardsOrMaps SharedDashboardsOrMaps properties Property Description Type create boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean sharedRecordsLists SharedRecordsLists SharedRecordsLists properties Property Description Type create boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean sharedReports SharedReports SharedReports properties Property Description Type create boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean unitSystemSettings UnitSystemSettings UnitSystemSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean updateApprovedBills UpdateApprovedBills UpdateApprovedBills properties Property Description Type delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string updateUnitsOnExistingBills UpdateUnitsOnExistingBills UpdateUnitsOnExistingBills properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string usersAndRoles UsersAndRoles UsersAndRoles properties Property Description Type description string isLicensed boolean licenseIndex integer[] manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean usersAndUserGroups UsersAndUserGroups UsersAndUserGroups properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean vendors Vendors Vendors properties Property Description Type create boolean delete boolean description string edit boolean isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string vendorsAndRatesModule VendorsAndRatesModule VendorsAndRatesModule properties Property Description Type description string isLicensed boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean weatherSettings WeatherSettings WeatherSettings properties Property Description Type description string isLicensed boolean manage boolean permissionCategoryName string permissionCode string permissionId integer (int32) permissionName string products PermissionProduct[] PermissionProduct properties Property Description Type productCode string productId integer (int32) productInfo string view boolean
products	List of products this system user role applies to	Product[]
Product properties Property Description Type productCode The product code string productId The product identifier integer (int32) productInfo The product info string
readOnly	Indicates the system user role that cannot be modified These roles can be hidden using the SetUserRoleHidden API	boolean
systemUserRoleId	Identifier for the system user role	integer (int32)
systemUserRoleName	Name of the system user role	string
usersAssignedCount	Number of users currently assigned to the system user role	integer (int32)

Example Response application/json Copy

[
  {    "description": "string",    "hidden": false,    "permissions": {      "accountingSettings": {},      "accounts": {},      "accountsModule": {},      "accountsModuleActualData": {},      "accrualSettings": {},      "allInstalledReports": {},      "applicationSettings": {},      "approveBills": {},      "baselineEngine": {},      "billCAPture": {},      "billListAdministrator": {},      "billWorkflowSettings": {},      "billsAndBatches": {},      "billsModule": {},      "budgetsAndBudgetVersions": {},      "buildingAndMeterGroups": {},      "buildingsAndMetersModule": {},      "buildingsAndMetersModuleActualData": {},      "buildingsAndMetersModuleBudgets": {},      "buildingsAndMetersModuleCalendarizedData": {},      "buildingsAndMetersModuleMeterIntervalData": {},      "buildingsAndMetersModuleNormalizedData": {},      "buildingsAndMetersModuleSavings": {},      "buildingsAndMetersModuleSustainability": {},      "buildingsAndOrganizations": {},      "chargebackReversals": {},      "chargebacks": {},      "chargebacksModule": {},      "collections": {},      "costCenters": {},      "dashboardAdministrator": {},      "dashboardAndMapsModule": {},      "distributedReportsSettings": {},      "emissionsSources": {},      "emissionsSourcesModule": {},      "energyManagerModule": {},      "energystarSubmissions": {},      "exportBills": {},      "exportHold": {},      "facilityProjects": {},      "flaggedItems": {},      "globalCostAvoidanceSettings": {},      "greenhouseGasAdministrator": {},      "groupsAndBenchmarksModule": {},      "intervalData": {},      "intervalDataAnalysis": {},      "intervalDataRollup": {},      "licenseFeatureAccountingExport": {},      "licenseFeatureAccrualBills": {},      "licenseFeatureBillCAPtureManagedServices": {},      "licenseFeatureBillCapturePostPay": {},      "licenseFeatureBillCapturePrePay": {},      "licenseFeatureBudgets": {},      "licenseFeatureCarbonHub": {},      "licenseFeatureChargebacks": {},      "licenseFeatureCostAvoidance": {},      "licenseFeatureCustomBenchmarks": {},      "licenseFeatureEnergyCAPPayments": {},      "licenseFeatureGhg": {},      "licenseFeatureGhgPremium": {},      "licenseFeatureIntervalData": {},      "licenseFeatureIntervalDataAnalysis": {},      "licenseFeatureLegacyGHG": {},      "licenseFeatureNonEnglishBills": {},      "licenseFeatureReportDesigner": {},      "licenseFeatureReportDistribution": {},      "licenseFeatureUIdI": {},      "licenseFeatureVendorManagementServices": {},      "manuallyAdjustSavings": {},      "meterSavingsSettings": {},      "meters": {},      "moveAccountsBetweenVendors": {},      "moveExistingBills": {},      "normalizationSettings": {},      "publicDashboardsOrMaps": {},      "rateSchedules": {},      "records": {},      "recordsListAdministrator": {},      "recordsModule": {},      "reportAdministrator": {},      "reportGroups": {},      "reports": {},      "reportsModule": {},      "resetUserPasswords": {},      "roles": {},      "savingsAdjustments": {},      "savingsEngine": {},      "sendNotifications": {},      "sharedBillLists": {},      "sharedDashboardsOrMaps": {},      "sharedRecordsLists": {},      "sharedReports": {},      "unitSystemSettings": {},      "updateApprovedBills": {},      "updateUnitsOnExistingBills": {},      "usersAndRoles": {},      "usersAndUserGroups": {},      "vendors": {},      "vendorsAndRatesModule": {},      "weatherSettings": {}
    },    "products": [
      {      "productCode": "string",      "productId": 1,      "productInfo": "string"
    }
    ],    "readOnly": false,    "systemUserRoleId": 1,    "systemUserRoleName": "string",    "usersAssignedCount": 1
  }
]