Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

runUserReport

Back to index

Summary

Run userReport to retrieve users activity data.

This report produces a list of users based on the applied time filter. If the selected time period is undefined, it selects all users since the license started. A new user entry appears in the report when:

  • The user has logged in the CloudBees CI system in the selected period.

  • The user has committed in the CloudBees CI system in the selected period.

actualParameter
Arrayoptional
Parameters passed as arguments to the report.
beginDate
Stringoptional
Start date.
endDate
Stringoptional
End date.
filter
Arrayoptional
A list of zero or more filter criteria definitions used to define objects to find.
format
Stringoptional
Response format.
Possible values: "csv", "json"
instance
Arrayoptional
Instance identifiers.
status
Stringoptional
User verification status.
Possible values: "UNVERIFIED", "VERIFIED"
tool
Stringoptional
Tool type.
Possible values: "cd", "ci", "sda"

Usage

Perl

$cmdr->runUserReport(
  # optionals
);
▼

ectool

ectool runUserReport \
  # optionals
▼

Examples

Perl

$cmdr->runUserReport("ci", {instances => "https://my.controller.com"});
▼

ectool

ectool runUserReport "ci" --instances https://my.controller.com
▼