getUsers

Summary

Retrieve all users.

By default, this command returns users who have been added to the CloudBees CD/RO database, which means they have logged in previously.

When calling getUsers, the default limit is 100 user records. Use the maximum option to specify a larger number, but this may inhibit performance. Or, you could define a search pattern to filter your search and conduct multiple queries.

filter

Stringoptional

Apply a glob-style filter (for example, foo*) when looking for users or groups.

includeAll

Booleanoptional

Whether to include all users or groups, or only users or groups that are known to the system.

maximum

Integeroptional

The maximum number of users or groups to return.

searchField

Arrayoptional

Filter search fields. Supported FulName or/and Email.

sortKey

Stringoptional

How to sort the results.

Possible values: "accessedOnLastLogin", "lastLoginTime", "userName"

sortOrder

Stringoptional

Specifies the order to sort the results.

Possible values: "ascending", "descending"

Usage

Perl

$cmdr->getUsers(
  # optionals
);▼

ectool

ectool getUsers \
  # optionals▼

Examples

Perl

$cmdr->getUsers();

$cmdr->getUsers({filter => '*Betty*', maximum => 25});▼

ectool

ectool getUsers

ectool getUsers --filter '*Betty*' --maximum 25▼