Knowledge Base

API Guide for Organizations Management (5.0)

Overview

This guide describes the Organizations API in Cloudmore. By using this API, you can integrate Cloudmore with your ERP, CRM, or other systems to keep customer data synchronized automatically, without manual data entry.

For authentication and general request structure, see Authentication and Getting started with APIs.

Full parameter details and response schemas are available in the Cloudmore Swagger documentation.


Managing Organizations

An organization is a customer that buys and consumes services from a Cloud Service Broker. Typically an organization represents a company, but it can also represent a business unit or department.

Operation

Method

Endpoint

Create an organization

POST

/api/resellers/{resellerId}/Organizations

Retrieve an organization

GET

/api/resellers/{resellerId}/Organizations/{id}

Retrieve all organizations

GET

/api/resellers/{resellerId}/Organizations

Update an organization

PUT

/api/resellers/{resellerId}/Organizations/{id}

Delete an organization

DELETE

/api/resellers/{resellerId}/Organizations/{id}

See the Organizations collection in Swagger for the full request and response schemas.


Managing Organization Services

Services available to an organization are listed in its E-Store and are determined by the broker. Adding a service to an organization enables access to it and may create records in external systems (for example, a Microsoft tenant) depending on the service configuration.

Organization service operations

Operation

Method

Endpoint

Add a service from the E-Store

POST

/api/resellers/{resellerId}/organizations/{organizationId}/services

Retrieve a service

GET

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}

Retrieve all services

GET

/api/resellers/{resellerId}/organizations/{organizationId}/services

Update a service

PUT

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}

Remove a service

DELETE

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}

See the OrganizationServices collection in Swagger.

E-Store operations

Operation

Method

Endpoint

Retrieve all services available to add

GET

/api/resellers/{resellerId}/organizations/{organizationId}/Estore

Retrieve details for one available service

GET

/api/resellers/{resellerId}/organizations/{organizationId}/Estore/{serviceId}

See the EStore collection in Swagger.