{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Orgs Licenses API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Orgs Licenses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "claimOrgLicense",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/claim",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Synchronously claims licenses and/or inventory devices from an activation code. All inventory devices are claimed immediately during the request."
        },
        {
          "info": {
            "name": "GetOrgLicenseAsyncClaimStatus",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/claim/status",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "detail",
                "value": "",
                "type": "query",
                "description": "Whether to include license details in the claim status response"
              }
            ]
          },
          "docs": "Return processing status for an asynchronous organization license claim, optionally including per-device license details."
        },
        {
          "info": {
            "name": "listOrgAsyncClaims",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/claims",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "detail",
                "value": "",
                "type": "query",
                "description": "Whether to include per-device detail in each claim record"
              }
            ]
          },
          "docs": "List all async inventory claim jobs for the organization, optionally including per-device details per claim."
        },
        {
          "info": {
            "name": "createOrgAsyncClaim",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/claims",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Schedules an async claim for inventory devices. Inventory claiming is queued and processed in the background; the response returns immediately with a `claim_id` for polling. Licenses (if `type=all`) are still claimed synchronously during the request.\n\nUse `GET /api/v1/orgs/{org_id}/claims/{claim_id}` to poll the result."
        },
        {
          "info": {
            "name": "getOrgAsyncClaimStatus",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/claims/:claim_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "claim_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the async claim job"
              },
              {
                "name": "detail",
                "value": "",
                "type": "query",
                "description": "Whether to include per-device detail in the claim status response"
              }
            ]
          },
          "docs": "Return the processing status for a specific async inventory claim job, optionally including per-device details."
        },
        {
          "info": {
            "name": "getOrgLicensesSummary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/licenses",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the organization license entitlement, subscription, amendment, consumption, and available-license summary."
        },
        {
          "info": {
            "name": "moveOrDeleteOrgLicenseToAnotherOrg",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/licenses",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Move, Undo Move or Delete Org License to Another Org\nIf the admin has admin privilege against the `org_id` and `dst_org_id`, he can move some of the licenses to another Org. Given that: \n1. the specified license is currently active \n2. there’s enough licenses left in the specified license (by subscription_id) \n3. there will still be enough entitled licenses for the type of license after the amendment"
        },
        {
          "info": {
            "name": "getOrgLicensesBySite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/licenses/usages",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Licenses Usage by Sites\nThis shows license usage (i.e. needed) based on the features enabled for the site."
        }
      ]
    }
  ],
  "bundled": true
}