Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

References

Requirements Doc: \Regions requirements

Document History

...

web services APIs

New APIs

* addRegion

             Parameters

...

Parameters

  1. id: Region Id
  2. name: Name of the Region
  3. endpoint: Region end point. e.g. http://10.147.30.11:8080/client
  4. userapikey: API key of the Admin user
  5. usersecretkey: Secret key of Admin user

* updateRegion

             Parameters

...

Parameters

  1. id: Region Id
  2. name: Name of the Region
  3. endpoint: Region end point. e.g. https://10.147.30.11:8080/client
  4. userapikey: API key of the Admin user
  5. usersecretkey: Secret key of Admin user

* removeRegion

             Parameters

...

Parameters

  1. id:

...

  1. id of the Region to  be removed

* listRegions

Parameters

  • listRegions

            Parameters

  1. id: List list by Region Id
  2. name: list by Region Name

* getUser

            Parameters 

  1. userapikey: Get user details by API key 

Changes to existing APIs

  • createAccount 
    1. New parameters
      1. accountid : External Id for the Account. Could be UUID or domainpath + username or any string unique across Regions
      2. userid: External Id for the User. 
      3. regionid: Id of the source Region where Account creation request was initiated
  • deleteAccount, updateAccount, disableAccount, enableAccount
    1. New parameters
      1. ispropagate: Boolean flag which indicated if the API call is being propagated from another Region

...

Appendix

Appendix A:

Appendix B: Edit\