ClaimKey Webservice

Find claim keys by org

Find the claim keys belonging to the authenticated organization, optionally filtered by state. Each claim key carries the term of one purchase, so this is how license term start/end dates are read programmatically. See getClaimKey for how to read the term fields. When filtering by state, note that a key past its endDate but inside its grace period has state EXPIRED, and a renewed key moves to RENEWED while its successor RENEWAL key carries the extended term - filtering to CLAIMED alone hides such coverage. To assess coverage, prefer excludeUnclaimed: true and compare endDate/gracePeriodEndDate per key. Organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.

post/api/license/claimkey/findClaimKeysByOrg

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByOrg
  • 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

Response

OK

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
warningMsgstring nullable

Example response

{
  "claimKeys": [
    {
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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