Page Comparison

...

You will need the following resources:

• More than one enterprise created in the platform

Your user role must include the following privileges.

• ENTERPRISE_ENUMERATE

• ENTERPRISE_ADMINISTER_ALL

Your user must have the new enterprise within your management scope.

The following pages describe the switch enterprise functionality in the Abiquo UI. 

...

In the Abiquo UI, you can switch enterprises in Home view or in Users view. For more details, see the following pages.

• https://abiquo.atlassian.net/wiki/pages/resumedraft.action?draftId=311370669

• Manage enterprises

Summary diagram

The steps in this diagram link to the API reference guide resources and data entities sections.

Detailed steps

Get the user entity by name

...

To get a cloud admin user from whichever enterprise they are currently in, run the get request with a wildcard for all enterprises represented by the underscore character "_". 

...

If you know the ID of the user, you can retrieve the user entity directly with the users link.
For example, the cloud admin user has an ID of 1, and the link as "https://example.com/api/admin/enterprises/_/users/1"

Or use the "has" parameter to perform a search for the user by text such as username, name, or details

curl -X GET \
  'https://example.com/api/admin/enterprises/_/users?has=cloudadmin' \
  -H 'Accept: application/vnd.abiquo.users+json;version=4.7' \

This request returns a collection of users, so find the required user

...

{"diagramDefinition":"graph TD\r\n\r\nZ(( ))\r\n\r\nstyle Z fill:#g1g,stroke:#100,stroke-width:20px\r\n\r\nZ-->A(Requires: More than one enterprise!)\r\n\r\nA -->B(<font color=0052cc>Get users by name)\r\n\r\nclick B href \"https://wiki.abiquo.com/api/latest/UsersResource.html#list-users\" _blank\r\n\r\nB -->C(<font color=0052cc>Get enterprises<br/>by name)\r\n\r\nclick C href \"https://wiki.abiquo.com/api/latest/EnterprisesResource.html#list-enterprises\" _blank\r\n\r\nC-->D(Modify the user entity to add<br/>the new 'enterprise' link)\r\n\r\nD-->E(<font color=0052cc>Update the user<br/>in any enterprise)\r\n\r\nclick E href \"https://wiki.abiquo.com/api/latest/UsersResource.html#update-a-user\" _blank\r\n\r\nE-->Q((<fontcolour=f3efe6> * ))\r\n\tstyle Q fill:#f3efe6,stroke:#030300,stroke-width:7px,color:#f3efe6"}

Detailed steps

1. Get the user entity by name

   • To get an administrator from the enterprise they are currently working in, without knowing the enterprise ID, use a URL with a wildcard for all enterprises, which is the underscore character "_". 

   • If you know the ID of the user, you can retrieve the user entity directly with the users link.
     For example, the cloud admin user has an ID of 1, so the link would be: "https://example.com/api/admin/enterprises/_/users/1"

   • Or use the "has" parameter to perform a search for the user by text such as username, name, or details

     Code Block
     curl -X GET \ 'https://example.com/api/admin/enterprises/_/users?has=cloudadmin' \ -H 'Accept: application/vnd.abiquo.users+json;version=4.7' \ -u admin:xabiquo k --verbose | jq .

     
     

   • This request returns a collection of users. Keep the required user entity, which starts with the braces before its ID

     Code Block

     { "totalSize": 1, "links": [ { "rel": "first", "href": "https://example.com:443/api/admin/enterprises/_/users?limit=25&has=cloudadmin&by=name&asc=true" }, { "rel": "last", "href": "https://example.com:443/api/admin/enterprises/_/users?startwith=0&limit=25&has=cloudadmin&by=name&asc=true" } ], "collection": [ { "id": 10, "nick": "cloudadmin", "name": "Cloud", "surname": "Admin", "description": "Secondary cloud admin user", "email": "cloudadmin@example.com", "locale": "en_US", "authType": "ABIQUO", "active": true, "publicSshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDgm0ckfblahblahblah", "allowedCIDRs": [], "firstLogin": false, "locked": false, "phoneNumber": "555123456", "links": [ { "title": "Marketing Department", "rel": "enterprise", "type": "application/vnd.abiquo.enterprise+json", "href": "https://example.com:443/api/admin/enterprises/3" }, { "title": "CLOUD_ADMIN", "rel": "role", "type": "application/vnd.abiquo.role+json", "href": "https://example.com:443/api/admin/roles/1" }, { "title": "cloudadmin", "rel": "edit", "type": "application/vnd.abiquo.user+json", "href": "https://example.com:443/api/admin/enterprises/3/users/10" }, { "title": "Global scope", "rel": "scope", "type": "application/vnd.abiquo.scope+json", "href": "https://example.com:443/api/admin/scopes/1" }, { "title": "virtual machines", "rel": "virtualmachines", "type": "application/vnd.abiquo.virtualmachines+json", "href": "https://example.com:443/api/admin/enterprises/3/users/10/action/virtualmachines" }, { "title": "pending tasks", "rel": "pendingtasks", "type": "application/vnd.abiquo.tasks+json", "href": "https://example.com:443/api/admin/enterprises/3/users/10/action/pendingtasks" }, { "title": "applications", "rel": "applications", "type": "application/vnd.abiquo.applications+json", "href": "https://example.com:443/api/admin/enterprises/3/users/10/applications" }, { "title": "async tasks", "rel": "asynctasks", "type": "application/vnd.abiquo.asynctasks+json", "href": "https://example.com:443/api/admin/enterprises/3/users/10/asynctasks" } ] } ] }

     
     

2. Get the new enterprise by name

   Code Block
   curl -X GET \ 'https://example.com/api/admin/enterprises?has=Finance' \ -H 'Accept: application/vnd.abiquo.enterprises+json;version=4.7' \

   
   

   1. Sample response

      Code Block

      { "totalSize": 1, "links": [ { "rel": "first", "href": "https://example.com:443/api/admin/enterprises?limit=25&has=Finance&by=name&asc=true" }, { "rel": "last", "href": "https://example.com:443/api/admin/enterprises?startwith=0&limit=25&has=Finance&by=name&asc=true" } ], "collection": [ { "id": 2, "name": "Finance Department", "isReservationRestricted": false, "workflow": false, "twoFactorAuthenticationMandatory": false, "reseller": false, "keyNode": false, "diskSoftLimitInMb": 0, "diskHardLimitInMb": 0, "storageSoftInMb": 0, "storageHardInMb": 0, "vmsSoft": 0, "vmsHard": 0, "vlansSoft": 0, "vlansHard": 0, "publicIpsSoft": 0, "publicIpsHard": 0, "repositorySoftInMb": 0, "repositoryHardInMb": 0, "links": [ { "title": "Finance Department", "rel": "edit", "type": "application/vnd.abiquo.enterprise+json", "href": "https://example.com:443/api/admin/enterprises/2" }, { "title": "users", "rel": "users", "type": "application/vnd.abiquo.users+json", "href": "https://example.com:443/api/admin/enterprises/2/users" }, { "title": "properties", "rel": "properties", "type": "application/vnd.abiquo.enterpriseproperties+json", "href": "https://example.com:443/api/admin/enterprises/2/properties" }, { "title": "Global scope", "rel": "scope", "type": "application/vnd.abiquo.scope+json", "href": "https://example.com:443/api/admin/scopes/1" }, { "title": "template definitions lists", "rel": "appslib/templateDefinitionLists", "type": "application/vnd.abiquo.templatedefinitionlists+json", "href": "https://example.com:443/api/admin/enterprises/2/appslib/templateDefinitionLists" }, { "title": "template defintion paths", "rel": "appslib/templateDefinitions", "type": "application/vnd.abiquo.templatedefinitions+json", "href": "https://example.com:443/api/admin/enterprises/2/appslib/templateDefinitions" }, { "title": "repositories", "rel": "datacenterrepositories", "type": "application/vnd.abiquo.datacenterrepositories+json", "href": "https://example.com:443/api/admin/enterprises/2/datacenterrepositories" }, { "title": "virtual machines", "rel": "virtualmachines", "type": "application/vnd.abiquo.virtualmachines+json", "href": "https://example.com:443/api/admin/enterprises/2/action/virtualmachines" }, { "title": "virtual appliances", "rel": "virtualappliances", "type": "application/vnd.abiquo.virtualappliances+json", "href": "https://example.com:443/api/admin/enterprises/2/action/virtualappliances" }, { "title": "ips", "rel": "ips", "type": "application/vnd.abiquo.privateips+json", "href": "https://example.com:443/api/admin/enterprises/2/action/ips" }, { "title": "virtual datacenters", "rel": "cloud/virtualdatacenters", "type": "application/vnd.abiquo.virtualdatacenters+json", "href": "https://example.com:443/api/admin/enterprises/2/action/virtualdatacenters" }, { "title": "reserved machines", "rel": "reservedmachines", "type": "application/vnd.abiquo.machines+json", "href": "https://example.com:443/api/admin/enterprises/2/reservedmachines" }, { "title": "limits", "rel": "limits", "type": "application/vnd.abiquo.limits+json", "href": "https://example.com:443/api/admin/enterprises/2/limits" }, { "title": "providerlimits", "rel": "providerlimits", "type": "application/vnd.abiquo.providerlimits+json", "href": "https://example.com:443/api/admin/enterprises/2/providerlimits" }, { "title": "volumes", "rel": "volumes", "type": "application/vnd.abiquo.volumes+json", "href": "https://example.com:443/api/admin/enterprises/2/action/volumes" }, { "title": "external networks", "rel": "externalnetworks", "type": "application/vnd.abiquo.vlans+json", "href": "https://example.com:443/api/admin/enterprises/2/action/externalnetworks" }, { "title": "pending tasks", "rel": "pendingtasks", "type": "application/vnd.abiquo.tasks+json", "href": "https://example.com:443/api/admin/enterprises/2/action/pendingtasks" }, { "title": "credentials", "rel": "credentials", "type": "application/vnd.abiquo.publiccloudcredentialslist+json", "href": "https://example.com:443/api/admin/enterprises/2/credentials" }, { "title": "pricingcredentials", "rel": "pricingcredentials", "type": "application/vnd.abiquo.pricingcredentialslist+json", "href": "https://example.com:443/api/admin/enterprises/2/pricingcredentials" }, { "title": "virtual appliances specs", "rel": "vappspecs", "type": "application/vnd.abiquo.virtualappliancespecs+json", "href": "https://example.com:443/api/admin/enterprises/2/vappspecs" }, { "title": "bills", "rel": "bills", "type": "application/vnd.abiquo.bills+json", "href": "https://example.com:443/api/statistics/enterpriseresources/2/bills" }, { "title": "billregisters", "rel": "billregisters", "type": "application/vnd.abiquo.bills+json", "href": "https://example.com:443/api/statistics/enterpriseresources/2/billregisters" }, { "title": "estimation", "rel": "estimation", "type": "text/plain", "href": "https://example.com:443/api/statistics/enterpriseresources/2/billregisters/action/estimate" }, { "title": "Bill providers", "rel": "billproviders", "type": "application/vnd.abiquo.billproviders+json", "href": "https://example.com:443/api/statistics/enterpriseresources/2/bills/action/providers" }, { "title": "Budgets", "rel": "budgets", "type": "application/vnd.abiquo.budgets+json", "

   id": 10,

   1. href": "https://example.com:443/api/admin/enterprises/2/budgets"

   "nick":
   "cloudadmin",

   1. }

   "name": "cloudadmin"

   1. ], "

   surname

   1. ramSoft":

   "cloudadmin"

   1. 0, "

   email

   1. ramHard":

   "cloudadmin@example.com"

   1. 0, "

   locale

   1. cpuSoft":

   "en_US"

   1. 0, "

   authType

   1. cpuHard":

   "ABIQUO",

   1. 0 } ]

   "active": true,

   1. }

      
      

   2. Find the required enterprise in the collection

   3. Save the enterprise "edit" link

      Code Block

   "publicSshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDgm0ckfxabLgc2a2cJlTyTdsZ4F5xNWHQqOZjOiZ/OEJ7jDXJiDz2cWiUNeNJJ49xFHHVo4R7QIROau8F5jhjvz1T6yPIcaI+EEqyKBNZtAuTxi7u9xwiuye4Zj6H37oAsxolRNBKg/nPCZ6SGNnVp2nhbN4bJS33Ia8rUSTa7yEbQxkduQndvNh64DscmxMwPiVJOcc9GJZz7gz1PcpeNNxP7Ir3giDSQF+TP4OyCDYV8nOQitGbxqNlJK3jcrx4nhaaY9As1xb5XD1e6X40fNg2+aW6z5rTh5PaEqPReyHDf7RxFWsgj58XUiJ4EPKvnV2EqM9DQINahlDlvIVG8G7p1dx+zT9VCZjEaHIuMQvK7MhStI9cE++TxhipPRfpPClDVQMguDs/JBpiztDZyCYe8szBo+IfxWl3im3pO4CjHqns1Kq0qR8AE7hc3wzNxR4wtX/jGN22LUDObfjVO3zYvnlDu9B3iTtFhS8MZ1N4Pk2/DKnN2/qg8nSNCufSZcFHnY2OV4Wspl5S5MIvz8nQMcl+0q+0BELeIdA0zhAzAaJMv0P8C/R9L0HVLCUFmzwIPW8rrEox5WgZjbxh5Fw3gDNk8/vCWZsKWsYFyy1MoFPt9JrfrO1/axb3xowFI04FcaXgk69SAMxfzL4LQuFCimprdj0gAea1gyswLvw== maryjane.smyth@abiquo.com",

   1. { "

   firstLogin

   1. title":

   false,

   1. "Finance Department", "

   locked

   1. rel":

   false,

   1. "edit", "

   links

   1. type":

   [

   1. "application/vnd.abiquo.enterprise+json",

   {

   1. "href": "https://example.com:443/api/admin/enterprises/2"

   1. },

      
      

3. Edit the user entity to add the new enterprise link

   1. Find the link with the "rel"

   : "enterprise",

   1. value of "enterprise" and replace it with the new enterprise link. For example, to switch to enterprise 2, you could use the link below

   2. Remember that the user entity must be complete in order to save the user, e.g. add an email attribute for the user because it is required.
      

   3. Sample enterprise link

      Code Block

   1. {

   1. "href": "https://example.com

   :443

   1. /api/admin/enterprises/

   275

   1. 2", "rel": "enterprise"

   }, { "title": "CLOUD_ADMIN",

   1. }

      
      

   2. Sample user entity with new enterprise link

      Code Block
      { "

   rel

   1. id":

   "role"

   1. 10,

   "type

   1. "nick": "

   application/vnd.abiquo.role+json

   1. cloudadmin",

   1. "

   href

   1. name": "

   https://example.com:443/api/admin/roles/1"

   1. Cloud",

   }

   1. "surname": "Admin", "description": "Secondary cloud

   {

   1. admin user",

   1. "

   title

   1. email": "

   cloudadmin

   1. cloudadmin@example.com",

   "rel

   1. "locale": "

   edit

   1. en_US", "authType": "ABIQUO",

   "type":
   "application/vnd.abiquo.user+json",

   1. "active": true, "

   href

   1. publicSshKey": "

   https://example.com:443/api/admin/enterprises/275/users/10"

   1. ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDblahblahblah", "allowedCIDRs": [],

   },

   1. "firstLogin": false,

   {

   1. "locked": false, "

   title

   1. phoneNumber": "

   Global scope

   1. 555123456", "links": [

   "rel": "scope",

   1. { "

   type

   1. rel": "

   application/vnd.abiquo.scope+json

   1. enterprise", "href": "https://example.com:443/api/admin/

   scopes

   1. enterprises/

   1

   1. 2" }, { "title": "

   virtual machines

   1. CLOUD_ADMIN", "rel": "

   virtualmachines

   1. role", "type": "application/vnd.abiquo.

   virtualmachines

   1. role+json", "href": "https://example.com:443/api/admin/

   enterprises/275/users/10/action/virtualmachines

   1. roles/1" }, { "title": "

   pending tasks

   1. cloudadmin", "rel": "

   pendingtasks

   1. edit", "type": "application/vnd.abiquo.

   tasks

   1. user+json", "href": "https://example.com:443/api/admin/enterprises/

   275

   1. 3/users/10

   /action/pendingtasks

   1. " }, { "title": "

   applications

   1. Global scope", "rel": "

   applications

   1. scope", "type": "application/vnd.abiquo.

   applications

   1. scope+json", "href": "https://example.com:443/api/admin/

   enterprises/275/users/10/applications

   1. scopes/1" }, { "title": "

   enable two factor authentication

   1. virtual machines", "rel": "

   enable2fa

   1. virtualmachines", "type": "application/vnd.abiquo.

   twofactorauthcredentials

   1. virtualmachines+json", "href": "https://example.com:443/api/admin/enterprises/

   275

   1. 3/users/10/action/

   enable2fa

   1. virtualmachines" }, { "title": "

   async

   1. pending tasks", "rel": "

   asynctasks

   1. pendingtasks", "type": "application/vnd.abiquo.

   asynctasks

   1. tasks+json", "href": "https://example.com:443/api/admin/enterprises

   /275/users/10/asynctasks"

   1. /3/users/10/action/pendingtasks" }, {

   }

   1. "title": "applications",

   ]
   }

   Edit the user entity and replace the enterprise link, for example to switch to enterprise 1224

   Code Block

   1. "rel": "applications",

   {

   1. "

   href

   1. type": "

   http://example.com/api/admin/enterprises/1224",

   1. application/vnd.abiquo.applications+json",

   "rel":
   "enterprise"
   }

   Update the user 

   1. Perform a PUT request to the user and replace the enterprise id in the URL with an underscore character "_". 

   2. Send the user entity that you modified above. Remember that the user entity must be complete in order to save the user, e.g. add an email attribute for the user if you didn't already add one because this is obligatory.

   3. cURL

      Code Block
      curl -X PUT \ "href": "https://example.com:443/api/admin/enterprises/_3/users/10 \/applications" -H 'Accept: application/vnd.abiquo.user+json;version=4.6' \ -H 'Content-Type: application/vnd.abiquo.user+json;version=4.6' \ }, -u user:password --verbose \ -d @requestpayload.json

      Sample response

      {

            {
            

      "id":
      10,

                   "

      nick

      title": "

      cloudadmin

      async tasks",
                    

      "name

            "rel": "

      cloudadmin

      asynctasks",
                          "

      surname

      type": "

      cloudadmin

      application/vnd.abiquo.asynctasks+json",
                  

      "email

              "href": "

      cloudadmin@example.com",

      https://example.com:443/api/admin/enterprises/3/users/10/asynctasks"
                  

      "locale":
      "en_US",

         }
               

      "authType":
      "ABIQUO",

        ]
              

      "active": true, "publicSshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDgm0ckfxabLgc2a2cJlTyTdsZ4F5xNWHQqOZjOiZ/OEJ7jDXJiDz2cWiUNeNJJ49xFHHVo4R7QIROau8F5jhjvz1T6yPIcaI+EEqyKBNZtAuTxi7u9xwiuye4Zj6H37oAsxolRNBKg/nPCZ6SGNnVp2nhbN4bJS33Ia8rUSTa7yEbQxkduQndvNh64DscmxMwPiVJOcc9GJZz7gz1PcpeNNxP7Ir3giDSQF+TP4OyCDYV8nOQitGbxqNlJK3jcrx4nhaaY9As1xb5XD1e6X40fNg2+aW6z5rTh5PaEqPReyHDf7RxFWsgj58XUiJ4EPKvnV2EqM9DQINahlDlvIVG8G7p1dx+zT9VCZjEaHIuMQvK7MhStI9cE++TxhipPRfpPClDVQMguDs/JBpiztDZyCYe8szBo+IfxWl3im3pO4CjHqns1Kq0qR8AE7hc3wzNxR4wtX/jGN22LUDObfjVO3zYvnlDu9B3iTtFhS8MZ1N4Pk2/DKnN2/qg8nSNCufSZcFHnY2OV4Wspl5S5MIvz8nQMcl+0q+0BELeIdA0zhAzAaJMv0P8C/R9L0HVLCUFmzwIPW8rrEox5WgZjbxh5Fw3gDNk8/vCWZsKWsYFyy1MoFPt9JrfrO1/axb3xowFI04FcaXgk69SAMxfzL4LQuFCimprdj0gAea1gyswLvw== maryjane.smyth@abiquo.com", "firstLogin": false, "locked": false, "links": [ { "rel": "enterprise", "href": "https://example.com:443/api/admin/enterprises/276" }, {

      }

      Expand
      Code Block

      
      

4. Update the user in any enterprise

   1. In the user URL, replace the enterprise ID with a wildcard to represent all enterprises, which is the underscore character "_". 

   2. Perform a PUT request to the user, sending the updated user entity

   3. cURL request

      Code Block
      curl -X PUT \ https://example.com/api/admin/enterprises/_/users/10 \ -H 'Accept: application/vnd.abiquo.user+json;version=4.7' \ -H 'Content-Type: application/vnd.abiquo.user+json;version=4.7' \ -u user:password --verbose \ -d @requestpayload.json

      
      

   4. Sample response. Success status code: 200

      Code Block

      { "id": 10, "nick": "cloudadmin", "name": "Cloud", "surname": "Admin", "description": "Secondary cloud admin user", "email": "cloudadmin@example.com", "locale": "en_US", "authType": "ABIQUO", "active": true, "publicSshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDgm0ckfblahblahblah", "allowedCIDRs": [], "firstLogin": false, "locked": false, "phoneNumber": "555123456", "links": [ { "title": " CLOUD_ADMIN Finance Department", "rel": " role enterprise", "type": "application/vnd.abiquo. role enterprise+json", "href": "https://example.com:443/api/admin/ roles enterprises/ 1 2" }, { { "title": " cloudadmin CLOUD_ADMIN", "rel": " edit role", "type": "application/vnd.abiquo. user role+json", "href": "https://example.com:443/api/admin/ enterprises/275/users/10" roles/1" }, { "title": " Global scope cloudadmin", "rel": " scope edit", "type": "application/vnd.abiquo. scope user+json", "href": "https://example.com:443/api/admin/enterprises/ scopes 2/users/ 1 10" }, { "title": " virtual Global machines scope", "rel": " virtualmachines scope", "type": "application/vnd.abiquo. virtualmachines scope+json", "href": "https://example.com:443/api/admin/ enterprises/275/users/10/action/virtualmachines" scopes/1" }, { "title": " pending virtual tasks machines", "rel": " pendingtasks virtualmachines", "type": "application/vnd.abiquo. tasks virtualmachines+json", "href": "https://example.com:443/api/admin/enterprises/ 275 2/users/10/action/ pendingtasks virtualmachines" }, { "title": " applications", pending tasks", "rel": " applications pendingtasks", "type": "application/vnd.abiquo. applications tasks+json", "href": "https://example.com:443/api/admin/enterprises/ 275 2/users/10/action/ applications" pendingtasks" }, { "title": " enable two factor authentication applications", "rel": " enable2fa applications", "type": "application/vnd.abiquo. twofactorauthcredentials applications+json ", ", "href": "https://example.com:443/api/admin/enterprises/ 275 2/users/10/ action/enable2fa applications" }, { "title": "async tasks", "rel": "asynctasks", "type": "application/vnd.abiquo.asynctasks+json", "href": "https://example.com:443/api/admin/enterprises/ 275 2/users/10/asynctasks" } ] }