Apache CloudStack v4.9.0 Root Admin API Reference


Lists user accounts

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
accounttypeList users by account type. Valid types include admin, domain-admin, read-only-admin, or user.false
domainidlist only resources belonging to the domain specifiedfalse
idList user by ID.false
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
stateList users by state of the user account.false
usernameList user by the usernamefalse

Response Tags

Response NameDescription
idthe user ID
accountthe account name of the user
accountidthe account ID of the user
accounttypethe account type of the user
apikeythe api key of the user
createdthe date and time the user account was created
domainthe domain name of the user
domainidthe domain ID of the user
emailthe user email address
firstnamethe user firstname
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
roleidthe ID of the role
rolenamethe name of the role
roletypethe type of the role
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name