Get the Virtual Accounts for a specific Smart Account used in this tenant - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get the Virtual Accounts for a specific Smart Account used in this tenant","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 the Virtual Accounts for a specific Smart Account used in this tenant. Note: This endpoint does not display all the Virtual Accounts within the Smart Account to which the customer has access. Only Virtual Accounts that have licenses used by devices in this tenant are displayed. Note: ⚠️ This endpoint is currently in limited availability. Please contact your Cisco account team or Cisco TAC to request access.","operationId":"getVirtualAccounts","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"}},{"description":"The unique identifier (UID) of the smart account","in":"path","name":"smartAccountUid","required":true,"schema":{"format":"uuid","type":"string"}}],"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 any of the licenses used in this tenant from this Virtual Account are out of compliance.","enum":["IN_COMPLIANCE","OUT_OF_COMPLIANCE"],"type":"string"},"lastUpdatedTime":{"description":"The time, in RFC 3339 format, when information on this Virtual Account was last updated","format":"date-time","type":"string"},"licensesInComplianceCount":{"description":"Number of licenses in this Virtual Account with in compliance status","format":"int32","type":"integer"},"licensesOutOfComplianceCount":{"description":"Number of licenses in this Virtual Account with out of compliance status","format":"int32","type":"integer"},"name":{"description":"Name of the Virtual Account.","type":"string"},"uid":{"description":"Unique identifier, represented as a UUID, for your Virtual Account","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/VirtualAccountDto"},"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/VirtualAccountsPage"}}},"description":"List of Virtual Accounts"},"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 the Virtual Accounts for a specific Smart Account used in this tenant.","tags":["Licensing"],"x-beta":"true","__originalOperationId":"getVirtualAccounts","method":"get","path":"/v1/licenses/smart-accounts/{smartAccountUid}/virtual-accounts"}}