Interface ILicensingSubscriptions

Namespace

Meraki.Api.Interfaces.Products.Licensing

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ILicensingSubscriptions

Extension Methods

ILicensingSubscriptionsExtensions.GetAdministeredLicensingSubscriptionSubscriptionsAllAsync(ILicensingSubscriptions, List<string>?, List<string>?, List<string>?, List<string>?, string?, string?, CancellationToken)

Methods

BindAdministeredLicensingSubscriptionSubscriptionAsync(string, LicensingSubscriptionBindRequest, CancellationToken)

Bind networks to a subscription

[Post("/administered/licensing/subscription/subscriptions/{subscriptionId}/bind")]
Task<LicensingSubscriptionBindings> BindAdministeredLicensingSubscriptionSubscriptionAsync(string subscriptionId, LicensingSubscriptionBindRequest licensingSubscriptionBindRequest, CancellationToken cancellationToken = default)

Parameters

subscriptionId string

Subscription ID

licensingSubscriptionBindRequest LicensingSubscriptionBindRequest

The subscription to be claimed

cancellationToken CancellationToken

Returns

Task<LicensingSubscriptionBindings>

Exceptions

ApiException

Thrown when fails to make API call

ClaimAdministeredLicensingSubscriptionSubscriptionsAsync(LicensingSubscriptionClaimRequest, CancellationToken)

Claim a subscription into an organization.

[Post("/administered/licensing/subscription/subscriptions/claim")]
Task<LicensingSubscriptionClaim> ClaimAdministeredLicensingSubscriptionSubscriptionsAsync(LicensingSubscriptionClaimRequest licensingSubscriptionClaimRequest, CancellationToken cancellationToken = default)

Parameters

licensingSubscriptionClaimRequest LicensingSubscriptionClaimRequest

The subscription to be claimed

cancellationToken CancellationToken

Returns

Task<LicensingSubscriptionClaim>

Exceptions

ApiException

Thrown when fails to make API call

GetAdministeredLicensingSubscriptionSubscriptionsAsync(int?, string, string, List<string>, List<string>, List<string>, List<string>, string, string, CancellationToken)

List available subscriptions

[Get("/administered/licensing/subscription/subscriptions")]
Task<List<LicensingSubscriptionSubscription>> GetAdministeredLicensingSubscriptionSubscriptionsAsync(int? perPage = 1000, string startingAfter = null, string endingBefore = null, List<string> subscriptionIds = null, List<string> organizationIds = null, List<string> statuses = null, List<string> productTypes = null, string startDate = null, string endDate = null, CancellationToken cancellationToken = default)

Parameters

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

startingAfter string

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.

endingBefore string

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.

subscriptionIds List<string>

List of subscription ids to fetch

organizationIds List<string>

Organizations to get associated subscriptions for

statuses List<string>

List of statuses that returned subscriptions can have

productTypes List<string>

List of product types that returned subscriptions need to have entitlements for.

startDate string

Filter subscriptions by start date, ISO 8601 format. To filter with a range of dates, use 'startDate[]=?' in the request. Accepted options include lt, gt, lte, gte.

endDate string

Filter subscriptions by end date, ISO 8601 format. To filter with a range of dates, use 'endDate[]=?' in the request. Accepted options include lt, gt, lte, gte.

cancellationToken CancellationToken

Returns

Task<List<LicensingSubscriptionSubscription>>

Exceptions

ApiException

Thrown when fails to make API call

ValidateAdministeredLicensingSubscriptionSubscriptionsClaimKey(LicensingClaimKeyValidationRequest, CancellationToken)

Find a subscription by claim key. Returns 400 if the key has already been claimed.

[Post("/administered/licensing/subscription/subscriptions/claimKey/validate")]
Task<LicensingClaimKeyValidation> ValidateAdministeredLicensingSubscriptionSubscriptionsClaimKey(LicensingClaimKeyValidationRequest licensingClaimKeyValidationRequest, CancellationToken cancellationToken = default)

Parameters

licensingClaimKeyValidationRequest LicensingClaimKeyValidationRequest

The Claim Key validation request

cancellationToken CancellationToken

Returns

Task<LicensingClaimKeyValidation>

Exceptions

ApiException

Thrown when fails to make API call