Apache CloudStack 4.19.0.0 Root Admin API Reference

oauthlogin

Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.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
emailEmail id with which user tried to login using OAuth providertrue
providerName of the providertrue
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 precedence.false
secretcodeCode that is provided by OAuth provider (Eg. google, github) after successful loginfalse

Response Tags

Response NameDescription
accountthe account name the user belongs to
domainidDomain ID that the user belongs to
firstnamefirst name of the user
is2faenabledIs two factor authentication enabled
is2faverifiedIs two factor authentication verified
issuerfor2faTwo factor authentication issuer
lastnamelast name of the user
providerfor2faTwo factor authentication provider
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
timezoneoffsetuser time zoneoffset
typethe account type (admin, domain-admin, read-only-admin, user)
useridUser ID
usernameUsername