Get the result of a Secure Client compatibility calculation - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get the result of a Secure Client compatibility calculation","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/241e37f202cf9838405f7ca5ed9f7d31d807d7bd/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.22.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://devfed.cdo.cisco.com/api/rest","description":"Devfed"},{"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"},{"url":"https://manage.securitydod.cisco/api/rest","description":"IL5"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get the aggregated compatible Secure Client versions for an MSP cross-tenant calculation, identified by the compatibility-info UID returned in the entity URL of the calculation's Transaction.","operationId":"getMspCompatibleSecureClientVersions","parameters":[{"description":"Unique identifier, represented as a UUID, of the Secure Client compatibility-info object returned by the calculation endpoint.","in":"path","name":"compatibilityInfoUid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Compatible Secure Client upgrade versions for MSP managed ASA devices across multiple tenants.","properties":{"compatibleVersions":{"description":"List of Secure Client versions compatible with the specified ASA devices across managed tenants. A version is included only if it is compatible with all of the requested devices in every managed tenant they belong to. The platforms listed for each version are likewise the intersection of platforms available in every managed tenant.","items":{"description":"A Secure Client version available across all requested managed tenants, with the platforms available for that version.","nullable":true,"properties":{"platforms":{"description":"The OS and CPU architecture combinations available for this Secure Client version across every requested managed tenant.","items":{"description":"An OS and CPU architecture combination available for a Secure Client version.","properties":{"cpuArchitecture":{"description":"The CPU architecture. One of: ARM64, X86_64, UNIVERSAL.","enum":["ARM64","X86_64","UNIVERSAL"],"type":"string"},"os":{"description":"The operating system. One of: LINUX, MACOS, WINDOWS.","enum":["LINUX","MACOS","WINDOWS"],"type":"string"}},"required":["cpuArchitecture","os"],"type":"object","$$ref":"#/components/schemas/MspCompatibleSecureClientPlatformDto"},"type":"array"},"version":{"description":"The Secure Client version string.","example":"5.1.15.287","type":"string"}},"required":["platforms","version"],"type":"object","$$ref":"#/components/schemas/MspCompatibleSecureClientVersionDto"},"nullable":true,"type":"array"},"errorMessage":{"description":"Error message detailing the issues that occurred during compatibility information retrieval. This field is populated when the status is ERROR.","example":"An error has occurred retrieving compatibility information. Contact Cisco TAC with the details below if you require additional support. The details of the error/s are: ...","nullable":true,"type":"string"},"status":{"description":"The current status of the retrieval of compatible Secure Client versions.","enum":["DONE","IN_PROGRESS","ERROR","IN_PROGRESS","DONE","ERROR"],"example":"DONE","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of this list of compatible Secure Client versions.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["status","uid"],"type":"object","$$ref":"#/components/schemas/MspSecureClientUpgradeCompatibilityInfoDto"}}},"description":"Compatible Secure Client upgrade versions for the requested MSP-managed ASA devices, aggregated across managed tenants."},"400":{"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"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"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"}},"type":"object","$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"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"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"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"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"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"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get the result of a Secure Client compatibility calculation","tags":["MSP Secure Client Management"],"x-beta":"true","__originalOperationId":"getMspCompatibleSecureClientVersions","method":"get","path":"/v1/msp/inventory/devices/secure-client/upgrades/versions/{compatibilityInfoUid}"}}