Partner Webservice

Deactivate managed client

MSP only. Soft-deletes a managed client org after a typed name confirmation. Refused while devices are registered or MSP-owned licenses are assigned; unassigned pooled licenses are reclaimed first; every session in the client org is ended; the MSP's authority row is kept so the org can be restored by Rhombus.

post/api/partner/deactivateClient

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/deactivateClient
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

confirmNamestring nullable

Typed confirmation; must match the client org name.

Example request

{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

deactivatedboolean nullable

True when the org was soft-deleted by this call (or already was).

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
reclaimedLicensesinteger nullable

Pooled licenses moved back to the MSP by this call.

warningMsgstring nullable

Example response

{
  "blockedByDevices": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "blockedByLicenses": [
    {
      "licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.