Knowledge Base

API Guide for User Management (5.0)

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

/api/resellers/{resellerId}/ResellerAdministrators

Return all administrators

GET

/api/resellers/{resellerId}/ResellerAdministrators

Return an administrator

GET

/api/resellers/{resellerId}/ResellerAdministrators/{id}

Update an administrator

PUT

/api/resellers/{resellerId}/ResellerAdministrators/{id}

Delete an administrator

DELETE

/api/resellers/{resellerId}/ResellerAdministrators/{id}

Reseller Roles

Operation

Method

API

Return all administrator roles

GET

/api/resellers/{resellerId}/ResellerRoles

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

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

Return all users

GET

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

Return a user

GET

/api/resellers/{resellerId}/organizations/{organizationId}/Users/{id}

Update a user

PUT

/api/resellers/{resellerId}/organizations/{organizationId}/Users/{id}

Delete a user

DELETE

/api/resellers/{resellerId}/organizations/{organizationId}/Users/{id}

Organization Roles

Operation

Method

API

Return all organization user roles

GET

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

Subscription User Assignment

Operation

Method

API

Return all users assigned to a subscription

GET

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId}/users

Assign a user to a subscription

POST

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId}/users

Update subscription external user ID

PUT

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId}/users

Remove a user from a subscription

DELETE

/api/resellers/{resellerId}/organizations/{organizationId}/services/{serviceId}/subscriptions/{subscriptionId}/users/{userId}

See the Swagger Documentation under the Users collection for full details.