Apache CloudStack v4.4.0 Domain Admin API Reference

disableAccount

Disables an account

Request parameters

Parameter NameDescriptionRequired
lockIf true, only lock the account; else disable the accounttrue
accountDisables specified account.false
domainidDisables specified account in this domain.false
idAccount idfalse

Response Tags

Response NameDescription
idthe id of the account
accountdetailsdetails for the account
accounttypeaccount type (admin, domain-admin, user)
cpuavailablethe total number of cpu cores available to be created for this account
cpulimitthe total number of cpu cores the account can own
cputotalthe total number of cpu cores owned by account
defaultzoneidthe default zone of the account
domainname of the Domain the account belongs too
domainidid of the Domain the account belongs too
groupsthe list of acl groups that account belongs to
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
isdefaulttrue if account is default, false otherwise
memoryavailablethe total memory (in MB) available to be created for this account
memorylimitthe total memory (in MB) the account can own
memorytotalthe total memory (in MB) owned by account
namethe name of the account
networkavailablethe total number of networks available to be created for this account
networkdomainthe network domain
networklimitthe total number of networks the account can own
networktotalthe total number of networks owned by account
primarystorageavailablethe total primary storage space (in GiB) available to be used for this account
primarystoragelimitthe total primary storage space (in GiB) the account can own
primarystoragetotalthe total primary storage space (in GiB) owned by account
projectavailablethe total number of projects available for administration by this account
projectlimitthe total number of projects the account can own
projecttotalthe total number of projects being administrated by this account
receivedbytesthe total number of network traffic bytes received
secondarystorageavailablethe total secondary storage space (in GiB) available to be used for this account
secondarystoragelimitthe total secondary storage space (in GiB) the account can own
secondarystoragetotalthe total secondary storage space (in GiB) owned by account
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
vpcavailablethe total number of vpcs available to be created for this account
vpclimitthe total number of vpcs the account can own
vpctotalthe total number of vpcs owned by 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
iscallerchilddomainthe boolean value representing if the updating target is in caller's child domain
isdefaulttrue if user is default, false otherwise
lastnamethe user lastname
secretkeythe secret key of the user
statethe user state
timezonethe timezone user was created in
usernamethe user name