Apache CloudStack 4.20.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 Name | Description | Required |
| Email id with which user tried to login using OAuth provider | true | |
| provider | Name of the provider | 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 precedence. | false |
| secretcode | Code that is provided by OAuth provider (Eg. google, github) after successful login | false |
Response Tags
| Response Name | Description |
| account | the account name the user belongs to |
| domainid | Domain ID that the user belongs to |
| firstname | first name of the user |
| is2faenabled | Is two factor authentication enabled |
| is2faverified | Is two factor authentication verified |
| issuerfor2fa | Two factor authentication issuer |
| lastname | last name of the user |
| providerfor2fa | Two factor authentication provider |
| 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 |
| timezoneoffset | user time zoneoffset |
| type | the account type (admin, domain-admin, read-only-admin, user) |
| userid | User ID |
| username | Username |