CloudStack v2.2.13 - 2.2.14 Domain Admin API Reference

listAccounts

Lists accounts and provides detailed account information for listed accounts

Request parameters

Parameter NameDescriptionRequired
accounttypelist accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).false
domainidlist only resources belonging to the domain specifiedfalse
idlist account by account IDfalse
iscleanuprequiredlist accounts by cleanuprequred attribute (values are true or false)false
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
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
namelist account by account namefalse
statelist accounts by state. Valid states are enabled, disabled, and locked.false

Response Tags

Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
ipavailablethe total number of public ip addresses available for this account to acquire
iplimitthe total number of public ip addresses this account can acquire
iptotalthe total number of public ip addresses allocated for this account
iscleanuprequiredtrue if the account requires cleanup
namethe name of the account
networkdomainthe network domain
receivedbytesthe total number of network traffic bytes received
sentbytesthe total number of network traffic bytes sent
snapshotavailablethe total number of snapshots available for this account
snapshotlimitthe total number of snapshots which can be stored by this account
snapshottotalthe total number of snapshots stored by this account
statethe state of the account
templateavailablethe total number of templates available to be created by this account
templatelimitthe total number of templates which can be created by this account
templatetotalthe total number of templates which have been created by this account
vmavailablethe total number of virtual machines available for this account to acquire
vmlimitthe total number of virtual machines that can be deployed by this account
vmrunningthe total number of virtual machines running for this account
vmstoppedthe total number of virtual machines stopped for this account
vmtotalthe total number of virtual machines deployed by this account
volumeavailablethe total volume available for this account
volumelimitthe total volume which can be used by this account
volumetotalthe total volume being used by this account
user(*)the list of users associated with account
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
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name