Partner

Get MSP license pool

MSP only. Per product: licenses owned by the MSP, how many sit unassigned in the pool, how many each managed client holds, and unclaimed keys.

POST/api/partner/license/getPool

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request for the MSP's license pool (no fields).

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partner/license/getPool' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/partner/license/getPool"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partner/license/getPool', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partner/license/getPool"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "products": [
    {
      "displayName": "<string>",
      "expiringWithin90d": 0,
      "heldByClients": [
        {
          "assignedToDevices": 0,
          "clientOrgName": "<string>",
          "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "count": 0
        }
      ],
      "heldByPool": 0,
      "owned": 0,
      "productCode": "<string>"
    }
  ],
  "unclaimedKeys": [
    {
      "accountAdminId": "<string>",
      "accountName": "<string>",
      "claimKeyUuid": "<string>",
      "contractEndDate": "<string>",
      "contractStartDate": "<string>",
      "createdDate": "<string>",
      "externalUuid": "<string>",
      "poNumber": "<string>"
    }
  ]
}

Response

200 OK

application/json · object

The MSP's license pool.

errorboolean | null

errorCodestring | null

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

errorMsgstring | null

productsobject[] | null

Show child attributes

displayNamestring | null

expiringWithin90dinteger<int32> | null

heldByClientsobject[] | null

Show child attributes

assignedToDevicesinteger<int32> | null

Of those, how many are assigned to a device.

clientOrgNamestring | null

clientOrgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

countinteger<int32> | null

Licenses of this product held by the client.

heldByPoolinteger<int32> | null

Unassigned licenses held by the MSP org itself.

ownedinteger<int32> | null

Every license owned by the MSP, wherever held.

productCodestring | null

unclaimedKeysobject[] | null

CREATED (not yet claimed) keys for the partner, as getClaimKeysForPartnerOrg returns them.

Show child attributes

accountAdminIdstring | null

accountNamestring | null

claimKeyUuidstring | null

contractEndDatestring | null

contractStartDatestring | null

createdDatestring | null

externalUuidstring | null

poNumberstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.