This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata


Jade provides the entire Business Logic layer for Extility. Jade provides two APIs. A User API, used by end users for manipulating virtual resources on the platform, and an Admin API used by administrators for various administrative functions. 

User API

Jade's User API allows end users of the platform to manipulate their own virtual resources. Authentication is by user and customer, meaning that a user who is so permitted can manipulate resources of different customers using the appropriate authentication credentials.

Administrators can use the customer API, authenticating as the administrator but passing the UsernameToken object set to the authentication username (the login username, a slash, and the customer UUID) of the customer concerned.

Admin API

Jade's AdminAPI provides a means for users with administrative access to perform administrative functions on the platform. Users with administrative access are:

  • Master Billing Entity administrators (administrators of the licensee who can administer all billing entities)
  • Other Billing Entity administrators (administrators of other billing entities, for instance resellers, who can only administer the Billing Entity to which they belong)

Jade provides a SOAP interface to allow authenticated administrators to perform administrative functions only within the Billing Entities they are authorised to use. For instance, they can:

  • List, search for, create, delete, or modify customers or users;
  • List transactions performed by a particular customer, or perform those transactions on the customer's behalf; and
  • Create, modify or delete Product Offers within the system.

Jade's AdminAPI does not permit administrators to manipulate the virtual resources of customers directly. In order to manipulate customer resources, administrators should use the User API, authenticating as the administrator but passing the UsernameToken object set to the authentication username (the login username, a slash, and the customer UUID) of the customer concerned.

Getting Started

There is a outline of the  Key Jade Concepts available, along with a Getting Started with Jade APIs guide, and Example API calls

  • No labels