List Protocol Identities - Cloud Security API

{"type":"api","title":"List Protocol Identities","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/5477656b-8124-3422-839e-4b90bc91faa4","info":{"title":"Cisco Secure Access App Discovery API","description":"The App Discovery API provides an overall view of application and protocol activity in your environment\nand the potential risk indicated by this network traffic.","version":"2.0.2","contact":{"name":"Cloud Security Developer Community"}},"tags":[{"name":"Applications"},{"name":"Application Categories"},{"name":"Protocols"},{"name":"Identities"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/reports/app-discovery-overview.md","uri":"secure-access-api-reference-app-discovery-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"reports.appDiscovery:write":"Write reports app discovery","reports.appDiscovery:read":"Read reports app discovery"}}}}}},"spec":{"tags":["Identities","Secure Access"],"summary":"List Protocol Identities","description":"List identities for a specific protocol.","operationId":"getProtocolIdentities","parameters":[{"in":"path","name":"protocolId","description":"The ID of the protocol.","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/protocolId"},{"in":"query","name":"date","schema":{"type":"string","format":"date"},"description":"Specify a date to search for data within a twenty-four hour time period.\nIf you do not provide a date, the last 90 days period is used to query the collection.","example":"2022-01-01","$$ref":"#/components/parameters/date"},{"in":"query","name":"limit","schema":{"type":"integer","minimum":1,"maximum":100},"description":"The maximum number of items to return in the collection.","$$ref":"#/components/parameters/limit"},{"in":"query","name":"offset","schema":{"type":"integer"},"description":"The number of items to skip before starting to collect the result set.","$$ref":"#/components/parameters/offset"},{"in":"query","name":"sort","schema":{"type":"string","enum":["firstDetected","lastDetected"]},"description":"Specify the name of a field to sort the application identities.","example":"lastDetected","$$ref":"#/components/parameters/identitiesSort"},{"in":"query","name":"order","schema":{"type":"string","enum":["asc","desc"]},"description":"Specify the order to sort the collection. Valid values are: `asc` (ascending)\nor `desc` (descending).","example":"asc","$$ref":"#/components/parameters/order"}],"security":[{"oauthFlow":["reports.appDiscovery:read"]}],"responses":{"200":{"description":"OK","headers":{"Link":{"schema":{"type":"string"},"description":"Links to related resources, in the format defined by\n[RFC 5988](https://tools.ietf.org/html/rfc5988#section-5).\nIf there is a next page, this header includes a link with relation type\n`next` to the next page.","$$ref":"#/components/headers/Link"}},"content":{"application/json":{"schema":{"type":"object","description":"The list of the app's identity information.","properties":{"items":{"type":"array","items":{"type":"object","description":"The app's identity information.","properties":{"id":{"type":"integer","description":"The ID of the identity.","example":10000},"name":{"type":"string","description":"The name of the identity.","example":"My Identity"},"events":{"type":"integer","example":100,"description":"The number of events for the identity."},"blockedEvents":{"type":"integer","description":"The number of blocked events for the identity.","example":50},"firstDetected":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the identity was first detected.","example":"2022-01-01T00:00:00.000Z"},"lastDetected":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the identity was last detected.","example":"2022-01-01T00:00:00.000Z"}},"example":{"id":10000,"name":"My identity","events":100,"blockedEvents":40,"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"},"$$ref":"#/components/schemas/ProtocolIdentity"}}},"example":{"items":[{"id":10000,"name":"My Identity","events":100,"blockedEvents":50,"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}]},"$$ref":"#/components/schemas/ProtocolIdentityList"},"example":{"items":[{"id":10000,"name":"My Identity","events":100,"blockedEvents":50,"firstDetected":"2022-01-01T00:00:00.000Z","lastDetected":"2022-01-01T00:00:00.000Z"}]}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/InvalidRequest"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","description":"The error message returned in the response.","properties":{"message":{"type":"string"}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/ServerError"}},"__originalOperationId":"getProtocolIdentities","method":"get","path":"/appDiscovery/protocols/{protocolId}/identities"}}