Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.

Request Parameters

Parameter Name Description Required
username Username true
password Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section. true
domain path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT domain is assumed. false

Response Tags

Response Name Description
username Username
userid User id
password Password
domainid domain ID that the user belongs to
timeout the time period before the session has expired
account the account name the user belongs to
firstname first name of the user
lastname last name of the user
type the account type (admin, domain-admin, read-only-admin, user)
timezone user time zone
timezoneoffset user time zone offset from UTC 00:00
sessionkey Session key that can be passed in subsequent Query command calls
Related Pages: listNetworks, restartNetwork, updateNetwork, associateIpAddress, disassociateIpAddress, listPublicIpAddresses, createLoadBalancerRule, deleteLoadBalancerRule, removeFromLoadBalancerRule, assignToLoadBalancerRule, listLoadBalancerRules, listLoadBalancerRuleInstances, updateLoadBalancerRule, listPortForwardingRules, createPortForwardingRule, deletePortForwardingRule, createFirewallRule, deleteFirewallRule, listFirewallRules, createRemoteAccessVpn, deleteRemoteAccessVpn, listRemoteAccessVpns, enableStaticNat, createIpForwardingRule, deleteIpForwardingRule, listIpForwardingRules, disableStaticNat, extractVolume, listZones, logout, listAccounts, queryAsyncJobResult, listAsyncJobs, listServiceOfferings, listDiskOfferings, registerSSHKeyPair, createSSHKeyPair, deleteSSHKeyPair, listSSHKeyPairs, listVirtualMachines, destroyVirtualMachine, rebootVirtualMachine, stopVirtualMachine, resetPasswordForVirtualMachine, changeServiceForVirtualMachine, updateVirtualMachine, getVMPassword, deployVirtualMachine, startVirtualMachine, listSnapshots, listSnapshotPolicies, deleteSnapshot, createSnapshot, createSnapshotPolicy, deleteSnapshotPolicies, listTemplates, createTemplate, registerTemplate, updateTemplate, copyTemplate, deleteTemplate, updateTemplatePermissions, listTemplatePermissions, extractTemplate, listSecurityGroups, createSecurityGroup, deleteSecurityGroup, authorizeSecurityGroupIngress, revokeSecurityGroupIngress, listVolumes, createVolume, attachVolume, detachVolume, deleteVolume, listNetworkOfferings, createNetwork, deleteNetwork, listTags, createTags, deleteTags