Interface IOrganizationsLicenses

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsLicenses

Extension Methods

IOrganizationsLicensesExtensions.GetOrganizationLicensesAllAsync(IOrganizationsLicenses, string, string?, string?, string?, CancellationToken)

Methods

AssignOrganizationLicensesSeatsAsync(string, LicenseSeatsAssignmentRequest, CancellationToken)

Assign SM seats to a network

[Post("/organizations/{organizationId}/licenses/assignSeats")]
Task<AssignSeatsResponse> AssignOrganizationLicensesSeatsAsync(string organizationId, LicenseSeatsAssignmentRequest licenseSeatsAssignmentRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseSeatsAssignmentRequest LicenseSeatsAssignmentRequest

cancellationToken CancellationToken

Returns

Task<AssignSeatsResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationLicenseAsync(string, string, CancellationToken)

Display a license

[Get("/organizations/{organizationId}/licenses/{licenseId}")]
Task<OrganizationLicense> GetOrganizationLicenseAsync(string organizationId, string licenseId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseId string

The license id

cancellationToken CancellationToken

Returns

Task<OrganizationLicense>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationLicensesAsync(string, int?, string?, string?, string?, string?, string?, CancellationToken)

List the licenses for an organization

[Get("/organizations/{organizationId}/licenses")]
Task<List<OrganizationLicense>> GetOrganizationLicensesAsync(string organizationId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? deviceSerial = null, string? networkId = null, string? state = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

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

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. (optional)

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. (optional)

deviceSerial string

Filter the licenses to those assigned to a particular device (optional)

networkId string

Filter the licenses to those assigned in a particular network (optional)

state string

Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'unused', 'unusedActive' or 'recentlyQueued' (optional)

cancellationToken CancellationToken

Returns

Task<List<OrganizationLicense>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationLicensesOverviewAsync(string, CancellationToken)

Return an overview of the license state for an organization

[Get("/organizations/{organizationId}/licenses/overview")]
Task<OrganizationLicenseState> GetOrganizationLicensesOverviewAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<OrganizationLicenseState>

Exceptions

ApiException

Thrown when fails to make API call

MoveOrganizationLicensesAsync(string, LicenseMoveRequest, CancellationToken)

Move licenses to another organization

[Post("/organizations/{organizationId}/licenses/move")]
Task<LicenseMoveRequest> MoveOrganizationLicensesAsync(string organizationId, LicenseMoveRequest licenseMoveRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseMoveRequest LicenseMoveRequest

Body for moving a license

cancellationToken CancellationToken

Returns

Task<LicenseMoveRequest>

Exceptions

ApiException

Thrown when fails to make API call

MoveOrganizationLicensesSeatsAsync(string, LicenseSeatsMoveRequest, CancellationToken)

Move SM seats to another organization

[Post("/organizations/{organizationId}/licenses/moveSeats")]
Task<LicenseSeatsMoveRequest> MoveOrganizationLicensesSeatsAsync(string organizationId, LicenseSeatsMoveRequest licenseSeatsMoveRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseSeatsMoveRequest LicenseSeatsMoveRequest

Body for moving SM seats

cancellationToken CancellationToken

Returns

Task<LicenseSeatsMoveRequest>

Exceptions

ApiException

Thrown when fails to make API call

RenewOrganizationLicensesSeatsAsync(string, LicenseSeatsRenewalRequest, CancellationToken)

Renew SM seats of a license

[Post("/organizations/{organizationId}/licenses/renewSeats")]
Task<AssignSeatsResponse> RenewOrganizationLicensesSeatsAsync(string organizationId, LicenseSeatsRenewalRequest licenseSeatsRenewalRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseSeatsRenewalRequest LicenseSeatsRenewalRequest

Body for renewing SM seats

cancellationToken CancellationToken

Returns

Task<AssignSeatsResponse>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationLicenseAsync(string, string, LicenseUpdateRequest, CancellationToken)

Update a license

[Put("/organizations/{organizationId}/licenses/{licenseId}")]
Task<OrganizationLicense> UpdateOrganizationLicenseAsync(string organizationId, string licenseId, LicenseUpdateRequest updateOrganizationLicense, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

licenseId string

The license id

updateOrganizationLicense LicenseUpdateRequest

Body for updating a license

cancellationToken CancellationToken

Returns

Task<OrganizationLicense>

Exceptions

ApiException

Thrown when fails to make API call