Manage Entitlements

Manage Entitlement Assignment Endpoints

Operations

Retrieve AssignmentsDeprecated

Request

Retrieve all the assignments (created and revoked).

Query

mspEcTenantIdstring

Use 'mspEcTenantId' optionally; if provided, assignments for the specified MSP-EC will be returned.

No request payload

Responses

List of entitlement assignments.

Bodyapplication/jsonArray [

idinteger(int64)

mspTenantIdstring

mspEcTenantIdstring

deviceTypestring

Enum"MSP_WIFI""MSP_SWITCH""MSP_EDGE""MSP_APSW""MSP_SLTN_TOKEN"

deviceSubTypestring

quantityinteger(int64)

dateEffectivestring(date-time)

dateExpiresstring(date-time)

trialAssignmentboolean

dateAssignmentCreatedstring(date-time)

dateAssignmentRevokedstring(date-time)

createdBystring

revokedBystring

extendedTrialboolean

almboolean

ownAssignmentboolean

statusstring

Enum"FUTURE""VALID""EXPIRED""REVOKED"

]

Response

application/json

[
  {
    "id": 0,
    "mspTenantId": "string",
    "mspEcTenantId": "string",
    "deviceType": "MSP_WIFI",
    "deviceSubType": "string",
    "quantity": 0,
    "dateEffective": "2019-08-24T14:15:22Z",
    "dateExpires": "2019-08-24T14:15:22Z",
    "trialAssignment": true,
    "dateAssignmentCreated": "2019-08-24T14:15:22Z",
    "dateAssignmentRevoked": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "revokedBy": "string",
    "extendedTrial": true,
    "alm": true,
    "ownAssignment": true,
    "status": "FUTURE"
  }
]

Create multiple assignmentsDeprecated

Request

Create a list of entitlement assignments for MSP owned devices

Bodyapplication/jsonrequired

assignmentsArray of objects(AssignmentACXRequest)required

List of assignments

assignments[].deviceTypestringrequired

MSP entitlement device type.

Enum"MSP_WIFI""MSP_SWITCH""MSP_EDGE""MSP_APSW""MSP_SLTN_TOKEN"

Example: "MSP_WIFI, MSP_SWITCH, MSP_APSW"

assignments[].quantityinteger(int64)required

Quantity of devices permitted by this assignment.

Example: 15

assignments[].useTemporaryMspEntitlementboolean

Trial MSP entitlement to be used for this assignment, if this parameter is not supplied in the request, it defaults to false.

Example: false

assignments[].deviceSubTypestring

startDatestringrequired

The date when the assignments starts.

Example: "2020-09-14 01:12:51Z"

endDatestringrequired

The date when the assignments ends.

Example: "2020-09-14 01:12:51Z"

application/json

{
  "assignments": [
    { … }
  ],
  "startDate": "2020-09-14 01:12:51Z",
  "endDate": "2020-09-14 01:12:51Z"
}

Responses

Bulk operation success

Bodyapplication/json

successboolean

assignmentsArray of objects(Assignment)

errorBriefstring

Enum"NO_CREATED_ASSIGNMENTS""ASSIGNMENT_CREATION_BAD_INPUT""NO_MSP_ENTITLEMENTS""MSP_ENTITLEMENTS_NOT_FOUND""INSUFFICIENT_MSP_ENTITLEMENTS""ASSIGNMENT_NOT_FOUND""TENANT_NOT_MSP""TENANT_NOT_FOUND""ENTITLEMENT_ID_NOT_FOUND""ASSIGNMENT_NOT_REVOCABLE"

errorMessagestring

veobject(ValidationErrors)

Response

application/json

{
  "success": true,
  "assignments": [
    { … }
  ],
  "errorBrief": "NO_CREATED_ASSIGNMENTS",
  "errorMessage": "string",
  "ve": {
    "object": "string",
    "objectName": "string",
    "value": "string",
    "expected": "string"
  }
}

Revoke multiple assignmentsDeprecated

Request

Revoke multiple assignments for MSP owned devices.

Bodyapplication/jsonrequiredArray [

assignmentIdinteger(int64)required

The ID of the assignment to be revoked.

Example: 231

]

application/json

[
  {
    "assignmentId": 231
  }
]

Responses

All entitlement assignments have been revoked.

Bodyapplication/json

successboolean

assignmentsArray of objects(Assignment)

errorBriefstring

Enum"NO_CREATED_ASSIGNMENTS""ASSIGNMENT_CREATION_BAD_INPUT""NO_MSP_ENTITLEMENTS""MSP_ENTITLEMENTS_NOT_FOUND""INSUFFICIENT_MSP_ENTITLEMENTS""ASSIGNMENT_NOT_FOUND""TENANT_NOT_MSP""TENANT_NOT_FOUND""ENTITLEMENT_ID_NOT_FOUND""ASSIGNMENT_NOT_REVOCABLE"

errorMessagestring

veobject(ValidationErrors)

Response

application/json

{
  "success": true,
  "assignments": [
    { … }
  ],
  "errorBrief": "NO_CREATED_ASSIGNMENTS",
  "errorMessage": "string",
  "ve": {
    "object": "string",
    "objectName": "string",
    "value": "string",
    "expected": "string"
  }
}

Replace multiple assignmentsDeprecated

Request

Replace multiple assignments for MSP owned devices.

Bodyapplication/jsonrequiredArray [

assignmentIdinteger(int64)required

The ID of the assignment to be replaced.

Example: 231

quantityinteger(int64)required

Quantity of devices permitted by this replacement assignment; the replacement assignment will be for the same MSP-EC and have the same device type, device sub type and is trial values as the assignment being revoked.

Example: 10

startDatestring

The date when the assignment starts.

Example: "2019-09-14 01:12:51Z"

endDatestring

The date when the assignment ends.

Example: "2020-09-14 01:12:51Z"

]

application/json

[
  {
    "assignmentId": 231,
    "quantity": 10,
    "startDate": "2019-09-14 01:12:51Z",
    "endDate": "2020-09-14 01:12:51Z"
  }
]

Responses

The entitlement assignment updated.

Bodyapplication/json

successboolean

assignmentsArray of objects(Assignment)

errorBriefstring

Enum"NO_CREATED_ASSIGNMENTS""ASSIGNMENT_CREATION_BAD_INPUT""NO_MSP_ENTITLEMENTS""MSP_ENTITLEMENTS_NOT_FOUND""INSUFFICIENT_MSP_ENTITLEMENTS""ASSIGNMENT_NOT_FOUND""TENANT_NOT_MSP""TENANT_NOT_FOUND""ENTITLEMENT_ID_NOT_FOUND""ASSIGNMENT_NOT_REVOCABLE"

errorMessagestring

veobject(ValidationErrors)

Response

application/json

{
  "success": true,
  "assignments": [
    { … }
  ],
  "errorBrief": "NO_CREATED_ASSIGNMENTS",
  "errorMessage": "string",
  "ve": {
    "object": "string",
    "objectName": "string",
    "value": "string",
    "expected": "string"
  }
}

MSP EntitlementsDeprecated

Request

Retrieve all the MSP's (bulk) entitlements.

No request payload

Responses

List of MSP entitlement.

Bodyapplication/jsonArray [

idstring

deviceTypestring

Enum"MSP_WIFI""MSP_SWITCH""MSP_EDGE""MSP_APSW""MSP_SLTN_TOKEN"

deviceSubTypestring

skustring

quantityinteger(int64)

effectiveDatestring(date-time)

expirationDatestring(date-time)

lastNotificationDatestring(date-time)

almboolean

almActivationIdstring

almSoEntQuantityinteger(int64)

isR1Skustring

statusstring

Enum"FUTURE""VALID""EXPIRED"

r1Skuboolean

isTrialboolean

]

Response

application/json

[
  {
    "id": "string",
    "deviceType": "MSP_WIFI",
    "deviceSubType": "string",
    "sku": "string",
    "quantity": 0,
    "effectiveDate": "2019-08-24T14:15:22Z",
    "expirationDate": "2019-08-24T14:15:22Z",
    "lastNotificationDate": "2019-08-24T14:15:22Z",
    "alm": true,
    "almActivationId": "string",
    "almSoEntQuantity": 0,
    "isR1Sku": "string",
    "status": "FUTURE",
    "r1Sku": true,
    "isTrial": true
  }
]

Refresh MSP EntitlementsDeprecated

Request

Refresh MSP entitlements.

Query

refreshboolean

No request payload

Responses

Retrieve a list of MSP entitlements, summaries and banners (with retrieval from License Service).

Bodyapplication/json

object

Response

application/json

{}

Retrieve MSP Banner DataDeprecated

Request

Retrieve banner data for the MSP's (bulk) entitlements. Banners provide information about MSP (bulk) entitlements that are either near their expiry or have expired.

No request payload

Responses

List of MSP entitlement banners.

Bodyapplication/jsonArray [

typestring

deviceTypestring

Enum"MSP_WIFI""MSP_SWITCH""MSP_EDGE""MSP_APSW""MSP_SLTN_TOKEN"

multipleLicenseboolean

effectDatestring(date-time)

effectDaysinteger(int64)

deviceCountinteger(int64)

affectedDeviceCountinteger(int64)

almboolean

almExtraEntitlementInfoDtoobject(AlmExtraEntitlementInfoDto)

]

Response

application/json

[
  {
    "type": "string",
    "deviceType": "MSP_WIFI",
    "multipleLicense": true,
    "effectDate": "2019-08-24T14:15:22Z",
    "effectDays": 0,
    "deviceCount": 0,
    "affectedDeviceCount": 0,
    "alm": true,
    "almExtraEntitlementInfoDto": { … }
  }
]

Get Entitlement Usage ReportDeprecated

Request

Get the entitlement usage report.

Query

licenseTypestring

Specific license type if the tenant is an ALM tenant, valid value: MSP_APSW (default), MSP_URLF, MSP_EDGE_SECS, MSP_EDGE_SECL

Enum"MSP_WIFI""MSP_WIFI_TEMP""MSP_ICX""MSP_ICX71L""MSP_ICX71""MSP_ICX75""MSP_ICX76""MSP_ICX78""MSP_ICX_ANY""MSP_EDGE"

startDatestring

The first date included in the usage report, for example, startDate=yyyy-mm-dd; if omitted, the startDate is set to last month's first date.

endDatestring

The end date included in the usage report, for example, endDate=yyyy-mm-dd; if omitted, the endDate is set to last month's last date.

monthstring

month=mm

yearstring

year=yyyy

mspEcTenantIdstring

Specific MSP EC tenant ID

deviceDetailsboolean

True to include device detail in the report. False to exclude device detail in the report.

Default false

pageinteger(int32)

Page number for the daily reports. If missing or value 0 means no pagination, all daily reports will be returned.

Default 0

pageSizeinteger(int32)

Page size for the daily reports, default is 5, valid only if page is given

Default 5

Headers

Content-Typestringrequired

No request payload

Responses

MSP usage report

Bodyapplication/json

object

Response

application/json

{}

Retrieve Device Type SummaryDeprecated

Request

Retrieve a summary by device type of all an MSP's entitlement assignments.

No request payload

Responses

Assignment Summaries by device type.

Bodyapplication/jsonArray [

deviceTypestring

Enum"MSP_WIFI""MSP_SWITCH""MSP_EDGE""MSP_APSW""MSP_SLTN_TOKEN"

deviceSubTypestring

quantityinteger(int64)

myAssignmentsinteger(int64)

courtesyMspEntitlementsUsedboolean

remainingDevicesinteger(int64)

trialboolean

licenseTypestring

Enum"MSP_WIFI""MSP_WIFI_TEMP""MSP_ICX""MSP_ICX71L""MSP_ICX71""MSP_ICX75""MSP_ICX76""MSP_ICX78""MSP_ICX_ANY""MSP_EDGE"

]

Response

application/json

[
  {
    "deviceType": "MSP_WIFI",
    "deviceSubType": "string",
    "quantity": 0,
    "myAssignments": 0,
    "courtesyMspEntitlementsUsed": true,
    "remainingDevices": 0,
    "trial": true,
    "licenseType": "MSP_WIFI"
  }
]

Entitlement Assignment Endpoints (0.2.0)