API Guide for User Management
Overview
This document explains how automating user creation with Cloudmore’s Users API can simplify access management across your organization.
It’s especially useful during employee onboarding and offboarding, allowing you to automatically grant or revoke access to the Cloudmore platform.
The same approach applies when onboarding new customers, where you can automatically create an Organization Admin user, who will act as the main contact and manage services on the customer’s side.
This helps streamline setup, improve security, and ensure a smooth onboarding experience for both internal users and external clients.
Broker Users Automation
Administration users can be created under a broker to allow the broker user to log in to Cloudmore and manage their services, customers, pricing, and billing. A reseller administrator account can be assigned different roles to limit the user’s access and capabilities.
API Details
Reseller Administrators
Operation | Swagger Description | Method | API |
|---|---|---|---|
Create an administrator | Creates a new administrator for the reseller | POST |
|
Return all administrators | Returns all reseller administrators | GET |
|
Return an administrator | Returns reseller administrator details | GET |
|
Update an administrator | Updates the reseller administrator | PUT |
|
Delete an administrator | Deletes the reseller administrator | DELETE |
|
Reseller Roles
Operation | Swagger Description | Method | API |
|---|---|---|---|
Return all administrator roles | Returns all reseller administrator roles | GET |
|
For more information related to the APIs, refer to the Swagger Documentation, with the collection ResellerAdministrators.
Organization Users Automation
Organizational users can be created and assigned to subscriptions. Before a user is assigned to a subscription, the user will first have to be created and assigned a role.
API Details
Users
Operation | Swagger Description | Method | API |
|---|---|---|---|
Return a user | Returns all organization users assigned to a subscription | POST |
|
Retrieve all users | Returns all organization users | GET |
|
Update a user | Returns user details | GET |
|
Delete a user | Updates the organization user | PUT |
|
Creates new users for the organization | Deletes the organization user | DELETE |
|
Organization Roles
Operation | Swagger Description | Method | API |
|---|---|---|---|
Retrieve all organization user roles | Returns all organization user roles | GET |
|
Organization Subscription Users
Operation | Swagger Description | Method | API |
|---|---|---|---|
Returns all organization users assigned to a subscription | Updates subscription external user ID | GET |
|
Updates subscription external user-id | Assign a user to a subscription. | PUT |
|
Assign a user to a subscription | Removes a user from the subscription | POST |
|
Removes a user from a subscription | Removes a user from a subscription | DELETE |
|
For more information related to the APIs, refer to the Swagger Documentation, with the collection Users.
Note: The lastAccessedDate parameter available in the GET APIs for Reseller Administrators and Users can be used to identify whether a customer is active or inactive. This helps in categorizing users based on their engagement with the Cloudmore platform.