Overview
This guide explains how to use the Cloudmore Users API to automate user management. Automating user creation is useful during employee onboarding and offboarding. It is also useful when onboarding new customers, where you can automatically create an Organization Admin user who manages services on the customer's behalf.
Broker Users API
Broker administrator accounts can be created and managed via API. Roles can be assigned to control each user's access level.
Reseller Administrators
|
Operation |
Method |
API |
|---|---|---|
|
Create an administrator |
POST |
|
|
Return all administrators |
GET |
|
|
Return an administrator |
GET |
|
|
Update an administrator |
PUT |
|
|
Delete an administrator |
DELETE |
|
Reseller Roles
|
Operation |
Method |
API |
|---|---|---|
|
Return all administrator roles |
GET |
|
See the Swagger Documentation under the ResellerAdministrators collection for full details.
Organization Users API
Organization users can be created and assigned to subscriptions. A user must be created and assigned a role before they can be assigned to a subscription.
Users
|
Operation |
Method |
API |
|---|---|---|
|
Create a user |
POST |
|
|
Return all users |
GET |
|
|
Return a user |
GET |
|
|
Update a user |
PUT |
|
|
Delete a user |
DELETE |
|
Organization Roles
|
Operation |
Method |
API |
|---|---|---|
|
Return all organization user roles |
GET |
|
Subscription User Assignment
|
Operation |
Method |
API |
|---|---|---|
|
Return all users assigned to a subscription |
GET |
|
|
Assign a user to a subscription |
POST |
|
|
Update subscription external user ID |
PUT |
|
|
Remove a user from a subscription |
DELETE |
|
See the Swagger Documentation under the Users collection for full details.