Cosmic 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 Name | Description | Required |
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 |
username | Username | 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 |
domainId | The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precendence | false |
Response Tags
Response Name | Description |
account | the account name the user belongs to |
domainid | Domain ID that the user belongs to |
domainname | Domain name that the user belongs to |
firstname | first name of the user |
lastname | last name of the user |
registered | Is user registered |
sessionkey | Session key that can be passed in subsequent Query command calls |
timeout | the time period before the session has expired |
timezone | user time zone |
type | the account type (admin, domain-admin, read-only-admin, user) |
userid | User ID |
username | Username |