Get licenses for MSP-managed devices - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get licenses for MSP-managed devices","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/830d1f62208c73e8aeba17d0e26773e8902a279e/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.18.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.uae.security.cisco.com/firewall","description":"UAE"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get device licenses, across all tenants, managed by the MSP portal. Note: ⚠️ This endpoint is currently in limited availability. Please contact your Cisco account team or Cisco TAC to request access.","operationId":"getMspDeviceLicenses","parameters":[{"description":"Number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":0,"type":"string"}},{"description":"Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The query to execute. Use the Lucene Query Syntax to construct your query.","example":"fieldName:fieldValue","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The fields to sort results by.","example":"name:DESC","in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"properties":{"complianceStatus":{"description":"Indicates whether the license used on the device is currently compliant with Smart Licensing restrictions.","enum":["IN_COMPLIANCE","OUT_OF_COMPLIANCE","UNKNOWN"],"example":"IN_COMPLIANCE","type":"string"},"deviceType":{"enum":["ASA","CDFMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FIREPOWER","ONPREM_FMC_NGIPS","FDM_MANAGED_FTD","IOS","ISR","SSH_DEVICE","GENERIC_DEVICE","MERAKI_MX","CLOUD_DNG","SFCN","SFCN_DNG","SFCN_STS","ONPREM_FMC","CDFMC","AWS_VPC","AZURE_VNET","DUO_ADMIN_PANEL","UMBRELLA_ORGANIZATION"],"type":"string","$$ref":"#/components/schemas/EntityType","description":"The type of the device.","example":"CDFMC_MANAGED_FTD"},"isEvaluationLicenseExpired":{"description":"Indicates if the evaluation license has expired. This field is only relevant if the license status is EVALUATION.","example":false,"type":"boolean"},"isExportControlFeaturesAllowed":{"description":"Indicates if export control features are allowed on the device.","example":true,"type":"boolean"},"lastUpdatedTime":{"description":"The time, in RFC 3339 format, that the license usage for this device was updated.","format":"date-time","type":"string"},"licenseStatus":{"description":"The license status of the device.","enum":["LICENSED","UNLICENSED","EVALUATION"],"example":"LICENSED","type":"string"},"licenses":{"description":"The list of licenses enabled on the device.","items":{"properties":{"endDate":{"format":"date-time","type":"string"},"licenseUid":{"format":"uuid","type":"string"},"name":{"type":"string"},"startDate":{"format":"date-time","type":"string"}},"type":"object","$$ref":"#/components/schemas/MspDeviceLicenseDetail"},"type":"array"},"managedTenantUid":{"description":"The unique identifier, represented as a UUID, of the managed tenant associated with the device.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","format":"uuid","type":"string"},"modelNumber":{"description":"The hardware, or virtualized hardware platform, that the device is running on (ASA-only). This field can be missing in the case of a partially onboarded device.","type":"string"},"name":{"description":"The name of the device in CDO. Device names are unique in Security Cloud Control.","example":"my-example-device","type":"string"},"serial":{"description":"The serial number of the device.","example":"JAD24500xxx","type":"string"},"smartAccount":{"properties":{"parent":{"description":"The name of the smart account used to license the device.","type":"string"},"virtual":{"description":"The name of the virtual account, within the smart account, used to license the device","type":"string"}},"type":"object","$$ref":"#/components/schemas/SmartAccountDto","description":"The smart account used to license this device."},"uid":{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/MspDeviceLicenseDto"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/MspDeviceLicensePage"}}},"description":"List of licenses for MSP-managed devices"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get licenses for MSP-managed devices","tags":["MSP Licensing"],"x-beta":"true","__originalOperationId":"getMspDeviceLicenses","method":"get","path":"/v1/msp/licenses/devices"}}