This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Common Cloud APIs

The following Cloud APIs are available:

Note: Before you add or delete users from your tenant, you must first log in to your tenant space in the Cloud as admin.

Login

DescriptionLog in to WSO2 Cloud's tenant space as admin.
URI

https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/user/authenticate/ajax/login.jag

URI Parameters
  • action: login
  • userName: Admin's username

  • password: Password of the admin

HTTP MethodsPOST
Example

curl -c cookies -k -v -X POST https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/user/authenticate/ajax/login.jag -d 'action=login&userName=<user name> &password=adminpassword'

The <user name> should be email@organization_key. For example, if the e-mail is jhon@gmail.com, the <user name> should be jhon@gmail.com@organization_key. You can find the organization_key on the Manage page of the cloud.

addUserToTenant

DescriptionCreate a new user in the Cloud
URIhttps://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag
URI Parameters
  • action: addUserToTenant
  • userEmail: Email address of the user
  • password: User's password should meet at least three of the below criteria:
    • Uppercase letters
    • Lowercase letters
    • Numbers
    • Special characters
  • firstName: User's first name (alphanumeric characters only)
  • lastName: User's last name (alphanumeric characters only)
  • roles: User's roles. Can take one or more of the following roles in a comma-separated list: integrationclouduser, subscriber, publisher, admin, devicemgtuser, devicemgtadmin
HTTP MethodsPOST
Example

curl -k -v -X POST https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag -b cookies -H 'Content­Type:application/x­www­form­urlencoded' -H 'Accept­Language:en­US,en;q=0.5' -­d 'action=addUserToTenant&userEmail=myemail@wso2.com&password=testPassword&firstName=testFirstName&lastName=testLastName&roles=subscriber'

deleteUserFromTenant

DescriptionDelete an existing user from your tenant
URI

https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag

URI Parameters
  • action: deleteUserFromTenant
  • userName: Email address of the user
HTTP MethodsPOST
Example

curl -­b cookies -­k -v -X POST https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag -­H 'Content­Type:application/x­www­form­urlencoded' -H 'Accept­Language:en­US,en;q=0.5'  -d 'action=deleteUserFromTenant&userName=myemail@wso2.com'