API Guide for Organizations Management

Overview

This document describes the utility of the Organizations API in Cloudmore for system integration.

By leveraging this API, businesses can synchronize customer data between Cloudmore and their ERP or CRM systems.

This ensures consistent and up-to-date customer information across platforms, streamlining operations and reducing manual data entry.

Manage Organizations

An organization is a tenant that buys and consumes a service from a Cloud Service Broker/Reseller. Usually, an organization represents a company, but it can also represent a business unit or department.

API Details

Operation	Swagger Description	Method	API
Create an Organization	Creates a new organization for the reseller	POST	`/api/resellers/{resellerId}/Organizations`
Retrieve an Organization	Returns organization details	GET	`/api/resellers/{resellerId}/Organizations/{id}`
Retrieve All Organizations	Returns all reseller organizations	GET	`/api/resellers/{resellerId}/Organizations`
Update an Organization	Updates the reseller organization	PUT	`/api/resellers/{resellerId}/Organizations/{id}`
Delete an Organization	Deletes the reseller organization	DELETE	`/api/resellers/{resellerId}/Organizations/{id}`

For more information related to the API, refer to the Swagger Documentation with the API collection (Organizations)

Manage Organization Services

Services accessible to an organization are listed in the E-store and are determined by the organization's Cloud Service Broker. When a service is added to an organization, it simply enables access to that service and may trigger the creation of tenants in external systems, depending on the service configuration.

API Details

Organization Services

Operation	Swagger Description	Method	API
Add a service from the E-Store to the organization	Adds available custom service from Estore to the organization	POST	`/api/resellers/{resellerId}/organizations/{organizationId}/services`
Retrieve organization service details	Returns organization service details	GET	`/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}`
Retrieve all organizations service details	Returns all organization services	GET	`/api/resellers/{resellerId}/organizations/{organizationId}/services`
Update an organizations service details	Updates the organization's services data	PUT	`/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}`
Delete an service from an organization	Removes custom service from the organization	DELETE	`/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}`

For more information related to the API, refer to the Swagger Documentation with the API collection (OrganizationServices)

Other

Operation	Swagger Description	Method	API
Retrieve services from the E-Store	Returns all services available for adding to the organization	GET	`/api/resellers/{resellerId}/organizations/{organizationId}/Estore`
Retrieves a service's details	Returns details for the service that can be added to the organization	GET	`/api/resellers/{resellerId}/organizations/{organizationId}/Estore/{serviceId}`

For more information related to the API, refer to the Swagger Documentation with the API collection (EStore)