Apache CloudStack v4.8.0 Domain Admin API Reference

login

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 NameDescriptionRequired
passwordHashed 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
usernameUsernametrue
domainPath 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
domainIdThe id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precendencefalse

Response Tags

Response NameDescription
accountthe account name the user belongs to
domainidDomain ID that the user belongs to
firstnamefirst name of the user
lastnamelast name of the user
registeredIs user registered
sessionkeySession key that can be passed in subsequent Query command calls
timeoutthe time period before the session has expired
timezoneuser time zone
typethe account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername