Licensing

`Licensing`

Licensing class.

`bind_administered_licensing_subscription_subscription`

Bind networks to a subscription.

API documentation: bindAdministeredLicensingSubscriptionSubscription

Parameters:

subscription_id (str) –

Subscription ID.
validate (bool | None, default: None ) –

Check if the provided networks can be bound to the subscription. Returns any licensing problems and does not commit the results.
network_ids (list[str] | None, default: None ) –

List of network ids to bind to the subscription.

Returns:

BindAdministeredLicensingSubscriptionSubscriptionResponse –

Successful operation.

Example API response

{
  "subscriptionId": "XY1234567",
  "networks": [
    {
      "id": "L_1234",
      "name": "Corporate network"
    }
  ],
  "errors": [
    "Insufficient licenses"
  ],
  "insufficientEntitlements": [
    {
      "sku": "LIC-MS-400-L-A",
      "quantity": 5
    }
  ]
}

`claim_administered_licensing_subscription_subscriptions`

Claim a subscription into an organization.

API documentation: claimAdministeredLicensingSubscriptionSubscriptions

Parameters:

validate (bool | None, default: None ) –

Check if the provided claim key is valid and can be claimed into the organization.
claim_key (str) –

The subscription's claim key.
organization_id (str) –

The id of the organization claiming the subscription.
name (str | None, default: None ) –

Friendly name to identify the subscription.
description (str | None, default: None ) –

Extra details or notes about the subscription.

Returns:

ClaimAdministeredLicensingSubscriptionSubscriptionsResponse –

Successful operation.

Example API response

{
  "subscriptionId": "2345",
  "name": "Corporate subscription",
  "description": "A description",
  "status": "active",
  "startDate": "2027-06-30T00:00:00Z",
  "endDate": "2028-06-30T00:00:00Z",
  "lastUpdatedAt": "2027-09-21T00:00:00Z",
  "webOrderId": "55598764",
  "type": "termed",
  "smartAccount": {
    "status": "active",
    "account": {
      "id": "99995678",
      "name": "Corporate Smart Account",
      "domain": "smart_account_domain"
    }
  },
  "renewalRequested": false,
  "productTypes": [
    "wireless"
  ],
  "entitlements": [
    {
      "sku": "LIC-MS-400-L-A",
      "seats": {
        "assigned": 10,
        "available": 15,
        "limit": 25
      }
    }
  ],
  "counts": {
    "seats": {
      "assigned": 10,
      "available": 15,
      "limit": 25
    },
    "networks": 1,
    "organizations": 1
  },
  "enterpriseAgreement": {
    "suites": [
      "networking"
    ]
  }
}

`get_administered_licensing_subscription_entitlements`

Retrieve the list of purchasable entitlements.

API documentation: getAdministeredLicensingSubscriptionEntitlements

Parameters:

skus (list[str] | None, default: None ) –

Filter to entitlements with the specified SKUs.

Returns:

PaginatedResponse[GetAdministeredLicensingSubscriptionEntitlementsResponseItem] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

{
  "sku": "LIC-MR-A",
  "name": "MR",
  "productType": "wireless",
  "productClass": "MR",
  "featureTier": "advantage",
  "isAddOn": false,
  "isFree": false
}

`get_administered_licensing_subscription_subscriptions`

List available subscriptions.

API documentation: getAdministeredLicensingSubscriptionSubscriptions

Parameters:

per_page (int | None, default: None ) –

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
starting_after (str | None, default: None ) –

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
ending_before (str | None, default: None ) –

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
subscription_ids (list[str] | None, default: None ) –

List of subscription ids to fetch.
organization_ids (list[str]) –

Organizations to get associated subscriptions for.
statuses (GetAdministeredLicensingSubscriptionSubscriptionsStatuses | None, default: None ) –

List of statuses that returned subscriptions can have.
product_types (GetAdministeredLicensingSubscriptionSubscriptionsProductTypes | None, default: None ) –

List of product types that returned subscriptions need to have entitlements for.
skus (list[str] | None, default: None ) –

List of SKUs that returned subscriptions need to have entitlements for.
name (str | None, default: None ) –

Search for subscription name.
start_date (str | None, default: None ) –

Filter subscriptions by start date, ISO 8601 format. To filter with a range of dates, use 'startDate[
end_date (str | None, default: None ) –

Filter subscriptions by end date, ISO 8601 format. To filter with a range of dates, use 'endDate[
total_pages (int | Literal['all'], default: 'all' ) –

use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.
direction (Literal['prev', 'next'], default: 'next' ) –

direction to paginate, either "next" (default) or "prev" page.

Returns:

PaginatedResponse[ClaimAdministeredLicensingSubscriptionSubscriptionsResponse] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "subscriptionId": "2345",
    "name": "Corporate subscription",
    "description": "A description",
    "status": "active",
    "startDate": "2027-06-30T00:00:00Z",
    "endDate": "2028-06-30T00:00:00Z",
    "lastUpdatedAt": "2027-09-21T00:00:00Z",
    "webOrderId": "55598764",
    "type": "termed",
    "smartAccount": {
      "status": "active",
      "account": {
        "id": "99995678",
        "name": "Corporate Smart Account",
        "domain": "smart_account_domain"
      }
    },
    "renewalRequested": false,
    "productTypes": [
      "wireless"
    ],
    "entitlements": [
      {
        "sku": "LIC-MS-400-L-A",
        "seats": {
          "assigned": 10,
          "available": 15,
          "limit": 25
        }
      }
    ],
    "counts": {
      "seats": {
        "assigned": 10,
        "available": 15,
        "limit": 25
      },
      "networks": 1,
      "organizations": 1
    },
    "enterpriseAgreement": {
      "suites": [
        "networking"
      ]
    }
  }
]

`get_administered_licensing_subscription_subscriptions_compliance_statuses`

Get compliance status for requested subscriptions.

API documentation: getAdministeredLicensingSubscriptionSubscriptionsComplianceStatuses

Parameters:

organization_ids (list[str]) –

Organizations to get subscription compliance information for.
subscription_ids (list[str] | None, default: None ) –

Subscription ids.

Returns:

PaginatedResponse[GetAdministeredLicensingSubscriptionSubscriptionsComplianceStatusesResponseItem] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "subscription": {
      "id": "12345",
      "name": "Corporate Subscription",
      "status": "active"
    },
    "violations": {
      "byProductClass": [
        {
          "productClass": "MS 100 Small",
          "gracePeriodEndsAt": "2023-12-07T00:00:00Z",
          "missing": {
            "entitlements": [
              {
                "sku": "LIC-MS-100-S-E",
                "quantity": 11
              }
            ]
          }
        }
      ]
    }
  }
]

`get_organization_licensing_coterm_licenses`

List the licenses in a coterm organization.

API documentation: getOrganizationLicensingCotermLicenses

Parameters:

organization_id (str) –

Organization ID.
per_page (int | None, default: None ) –

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
starting_after (str | None, default: None ) –

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
ending_before (str | None, default: None ) –

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
invalidated (bool | None, default: None ) –

Filter for licenses that are invalidated.
expired (bool | None, default: None ) –

Filter for licenses that are expired.
total_pages (int | Literal['all'], default: 'all' ) –

use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.
direction (Literal['prev', 'next'], default: 'next' ) –

direction to paginate, either "next" (default) or "prev" page.

Returns:

PaginatedResponse[GetOrganizationLicensingCotermLicensesResponseItem] –

Successful operation.

Note

Returns a lazy PaginatedResponse that can be iterated or collected with .collect(). Page metadata is available on .meta and .meta_pages.

Example API response

[
  {
    "key": "Z2AA-BBBB-CCCC",
    "organizationId": "123456",
    "duration": 365,
    "mode": "addDevices",
    "startedAt": "2022-05-02T10:52:00Z",
    "claimedAt": "2022-07-04T16:23:00Z",
    "invalidated": true,
    "invalidatedAt": "2022-07-04T16:23:00Z",
    "expired": false,
    "editions": [
      {
        "edition": "Enterprise",
        "productType": "appliance"
      }
    ],
    "counts": [
      {
        "model": "MR Enterprise",
        "count": 2
      }
    ]
  }
]

`move_organization_licensing_coterm_licenses`

Moves a license to a different organization (coterm only).

API documentation: moveOrganizationLicensingCotermLicenses

Parameters:

organization_id (str) –

Organization ID.
destination (MoveOrganizationLicensingCotermLicensesDestination) –

Destination data for the license move.
licenses (list[MoveOrganizationLicensingCotermLicensesLicensesItem]) –

The list of licenses to move.

Returns:

MoveOrganizationLicensingCotermLicensesResponse –

Successful operation.

Example API response

{
  "remainderLicenses": [
    {
      "key": "Z2AA-BBBB-CCCC",
      "organizationId": "123456",
      "duration": 365,
      "mode": "addDevices",
      "startedAt": "2022-05-02T10:52:00Z",
      "claimedAt": "2022-07-04T16:23:00Z",
      "invalidated": true,
      "invalidatedAt": "2022-07-04T16:23:00Z",
      "expired": false,
      "editions": [
        {
          "edition": "Enterprise",
          "productType": "appliance"
        }
      ],
      "counts": [
        {
          "model": "MR Enterprise",
          "count": 2
        }
      ]
    }
  ],
  "movedLicenses": [
    {
      "key": "Z2AA-BBBB-CCCC",
      "organizationId": "123456",
      "duration": 365,
      "mode": "addDevices",
      "startedAt": "2022-05-02T10:52:00Z",
      "claimedAt": "2022-07-04T16:23:00Z",
      "invalidated": true,
      "invalidatedAt": "2022-07-04T16:23:00Z",
      "expired": false,
      "editions": [
        {
          "edition": "Enterprise",
          "productType": "appliance"
        }
      ],
      "counts": [
        {
          "model": "MR Enterprise",
          "count": 2
        }
      ]
    }
  ]
}

`validate_administered_licensing_subscription_subscriptions_claim_key`

Find a subscription by claim key.

API documentation: validateAdministeredLicensingSubscriptionSubscriptionsClaimKey

Parameters:

claim_key (str) –

The subscription's claim key.

Returns:

ClaimAdministeredLicensingSubscriptionSubscriptionsResponse –

Successful operation.

Example API response

{
  "subscriptionId": "2345",
  "name": "Corporate subscription",
  "description": "A description",
  "status": "active",
  "startDate": "2027-06-30T00:00:00Z",
  "endDate": "2028-06-30T00:00:00Z",
  "lastUpdatedAt": "2027-09-21T00:00:00Z",
  "webOrderId": "55598764",
  "type": "termed",
  "smartAccount": {
    "status": "active",
    "account": {
      "id": "99995678",
      "name": "Corporate Smart Account",
      "domain": "smart_account_domain"
    }
  },
  "renewalRequested": false,
  "productTypes": [
    "wireless"
  ],
  "entitlements": [
    {
      "sku": "LIC-MS-400-L-A",
      "seats": {
        "assigned": 10,
        "available": 15,
        "limit": 25
      }
    }
  ],
  "counts": {
    "seats": {
      "assigned": 10,
      "available": 15,
      "limit": 25
    },
    "networks": 1,
    "organizations": 1
  },
  "enterpriseAgreement": {
    "suites": [
      "networking"
    ]
  }
}