Description | List users from a group or a search by name fragment (userId, display name, and email). Use name of @all to search by name fragment for all characters - this should avoided if you have a group containing all users. Or use project and role to get all users that are part of the role for the project specified. Email filtering will not work if email visibility is off or on Cloud using name search. Include inactive only works for user name searches. For Cloud, customers and apps account types are not included by default, but are available using '--options includeCustomers' or '--options includeApps'. |
|---|
Required Parameters | (group or name or (project and role)) |
|---|
Optional Parameters | limit, regex, includeInactive, outputType, file, columns, select, options, encoding, append, outputFormat |
|---|
Type | Get |
|---|
Category | Users |
|---|
Output Formats | 1 - basic, 2 - extended attributes including key and groups, 101 - key and name only, 999 - all including accountType |
|---|
Replacement Variables | |
|---|
| Hosting | cloud,server,datacenter |
|---|
| Since Version | |
|---|
Examples | getUserList |
|---|
|