List References for Service Objects - Cloud Security API

{"type":"api","title":"List References for Service Objects","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/b36b2683-243e-3edc-8c84-85b5f4140afd","info":{"version":"1.0.1","title":"Cisco Secure Access Network and Service Objects API","description":"Manage the Network and Service Objects in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Objects","description":"Manage the Network Objects in the organization."},{"name":"Network Object Groups","description":"Manage the Network Object Groups in the organization."},{"name":"Service Objects","description":"Manage the Service Objects in the organization."},{"name":"Service Object Groups","description":"Manage the Service Object Groups in the organization."},{"name":"Unified Objects","description":"List the Objects and Object Groups in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/network-and-service-objects-overview.md","uri":"secure-access-api-reference-network-and-service-objects-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.objects.networkObjects:read":"Read the Network Object resources","policies.objects.networkObjectGroups:read":"Read the Network Object Group resources","policies.objects.networkObjects:write":"Write the Network Object resources","policies.objects.networkObjectGroups:write":"Write the Network Object Group resources","policies.objects.serviceObjects:read":"Read the Service Object resources","policies.objects.serviceObjectGroups:read":"Read the Service Object Groups resources","policies.objects.serviceObjects:write":"Write the Service Object resources","policies.objects.serviceObjectGroups:write":"Write the Service Object Group resources"}}}}}},"spec":{"tags":["Service Objects","Secure Access"],"summary":"List References for Service Objects","description":"Get the references for the Service Objects in the organization.\nA reference is an access rule or Service Object Group that includes a Service Object.","parameters":[{"name":"values","in":"query","description":"The IDs for the objects or groups.","required":false,"schema":{"type":"array","description":"The list of IDs for the objects or groups.","items":{"type":"integer","description":"The ID of the object or group."}},"example":[76534,1234],"$$ref":"#/components/parameters/values"}],"security":[{"oauthFlow":["policies.objects.serviceObjects:read"]}],"operationId":"getReferencesForServiceObjects","responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The metadata and properties of the references.","required":["count","limit","offset","results"],"properties":{"count":{"type":"integer","description":"The number of references in the response.","example":3},"limit":{"type":"integer","description":"The maximum number of items from the collection that are returned in the response.","example":100,"$$ref":"#/components/schemas/limit"},"offset":{"type":"integer","description":"The place (index) to start reading in the collection.","example":0,"$$ref":"#/components/schemas/offset"},"results":{"type":"array","description":"The list of properties for the object references.","items":{"properties":{"id":{"type":"integer","description":"The ID of the object.","example":123456,"$$ref":"#/components/schemas/idReference"},"rules":{"type":"array","description":"The list of the references for the rules.","items":{"type":"object","description":"The properties of the rule.","required":["id","name"],"properties":{"id":{"type":"integer","description":"The ID of the rule.","example":76534},"name":{"type":"string","description":"The name of the rule.","example":"Rule Name"}},"example":{"name":"the rule name","id":76534},"$$ref":"#/components/schemas/ReferencedRulesResponseSchema"},"$$ref":"#/components/schemas/rules"},"groups":{"type":"array","description":"The list of the references for the groups.","items":{"type":"object","description":"The properties of the group.","required":["id","name"],"properties":{"id":{"type":"integer","description":"The ID of the group.","example":76534},"name":{"type":"string","description":"The name of the group.","example":"Group Name"}},"example":{"id":76543,"name":"The group name"},"$$ref":"#/components/schemas/ReferencedGroupsResponseSchema"},"$$ref":"#/components/schemas/groups"}}}}}},"example":{"count":11,"limit":20,"offset":0,"results":[{"id":13,"rules":[],"groups":[{"id":4263,"name":"test"}]},{"id":14,"rules":[{"id":1036500,"name":"test destination network one"}],"groups":[{"id":4285,"name":"test group three"}]}]}}},"$$ref":"#/components/responses/CollectionReferenceResponse"},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Organization ID must be a numeric value."}},"$$ref":"#/components/schemas/400ErrorObject"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."}},"$$ref":"#/components/schemas/401ErrorObject"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"}},"$$ref":"#/components/schemas/403ErrorObject"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"}},"$$ref":"#/components/schemas/404ErrorObject"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"}},"$$ref":"#/components/schemas/500ErrorObject"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getReferencesForServiceObjects","method":"get","path":"/objects/serviceObjects/references"}}