Delete Multiple User Activity - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Delete Multiple User Activity","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"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.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.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Delete users. Use query parameters to limit which users will be deleted. _Check the response section for applicable examples (if any)._**","operationId":"deleteMultipleUserActivity","parameters":[{"description":"Required parameter, should be always set to \u003ccode\u003etrue\u003c/code\u003e","in":"query","name":"bulk","required":true,"schema":{"type":"boolean"}},{"description":"Delete all user activities. When set to \u003ccode\u003etrue\u003c/code\u003e event query parameters should be absent.","in":"query","name":"deleteAll","required":false,"schema":{"type":"boolean"}},{"description":"Search based on the time, format: \u003ccode\u003e{before|after}:{time}\u003c/code\u003e or \u003ccode\u003eafter:{time},before:{time}\u003c/code\u003e, where time takes Long value (Unix Timestamp).","in":"query","name":"time","required":true,"schema":{"type":"string"}},{"description":"Search based on event. Operator: \u003ccode\u003eCONTAINS\u003c/code\u003e.","in":"query","name":"event","required":false,"schema":{"type":"string"}},{"description":"Search based on username. Operator: \u003ccode\u003eCONTAINS\u003c/code\u003e (i.e. search for ana will return users with usernames ana, banana, canada).","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"description":"Search based on realm. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"realmName","required":false,"schema":{"type":"string"}},{"description":"Search based on realm type (LDAP, Microsoft Azure). Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"discoveryApplication","required":false,"schema":{"type":"string"}},{"description":"Search based on authentication type. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"authenticationType","required":false,"schema":{"type":"string"}},{"description":"Search based on IP address. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.","in":"query","name":"ipAddress","required":false,"schema":{"type":"string"}},{"description":"Search based on start port. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"startPort","required":false,"schema":{"type":"string"}},{"description":"Search based on end port. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"endPort","required":false,"schema":{"type":"string"}},{"description":"Search based on description. Operator: \u003ccode\u003eCONTAINS\u003c/code\u003e","in":"query","name":"description","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn session type. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnSessionType","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn group policy. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnGroupPolicy","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn connection profile. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnConnectionProfile","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn client public IP. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.","in":"query","name":"vpnClientPublicIP","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn client country. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnClientCountry","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn client OS. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnClientOS","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn client application. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnClientApplication","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn connection duration. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnConnectionDuration","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn bytes transmitted. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnBytesOut","required":false,"schema":{"type":"string"}},{"description":"Search based on vpn received. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"vpnBytesIn","required":false,"schema":{"type":"string"}},{"description":"Search based on security group tag. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"securityGroupTag","required":false,"schema":{"type":"string"}},{"description":"Search based on endpoint profile. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"endpointProfile","required":false,"schema":{"type":"string"}},{"description":"Search based on endpoint location. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e. Or search based on the subnet or range, example: 192.168.1.0/24, 192.168.0.1-192.168.0.5.","in":"query","name":"endpointLocation","required":false,"schema":{"type":"string"}},{"description":"Search based on device. Operator: \u003ccode\u003eEQUALS\u003c/code\u003e.","in":"query","name":"device","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : DELETE /fmc_config/v1/domain/domainUUID/analysis/useractivity ( Success: Test delete )":{"value":{"ids":["id1","id2","id3"]}}},"schema":{"type":"object","properties":{"authenticationType":{"type":"string"},"description":{"type":"string"},"device":{"type":"string"},"discoveryApplication":{"type":"string"},"endPort":{"format":"int32","type":"integer"},"endpointLocation":{"type":"string"},"endpointProfile":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"ipAddress":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"realmName":{"type":"string"},"securityGroupTag":{"type":"string"},"startPort":{"format":"int32","type":"integer"},"time":{"format":"int32","type":"integer"},"type":{"type":"string"},"username":{"type":"string"},"version":{"type":"string"},"vpnBytesIn":{"format":"int32","type":"integer"},"vpnBytesOut":{"format":"int32","type":"integer"},"vpnClientApplication":{"type":"string"},"vpnClientCountry":{"type":"string"},"vpnClientOS":{"type":"string"},"vpnClientPublicIP":{"type":"string"},"vpnConnectionDuration":{"format":"int32","type":"integer"},"vpnConnectionProfile":{"type":"string"},"vpnGroupPolicy":{"type":"string"},"vpnSessionType":{"type":"string"}},"$$ref":"#/components/schemas/UserActivity"}}},"description":"Input representation of user activity.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : DELETE /fmc_config/v1/domain/domainUUID/analysis/useractivity ( Success: Test delete )":{"value":{"links":{}}}},"schema":{"type":"object","properties":{"authenticationType":{"type":"string"},"description":{"type":"string"},"device":{"type":"string"},"discoveryApplication":{"type":"string"},"endPort":{"format":"int32","type":"integer"},"endpointLocation":{"type":"string"},"endpointProfile":{"type":"string"},"event":{"type":"string"},"id":{"type":"string"},"ipAddress":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"realmName":{"type":"string"},"securityGroupTag":{"type":"string"},"startPort":{"format":"int32","type":"integer"},"time":{"format":"int32","type":"integer"},"type":{"type":"string"},"username":{"type":"string"},"version":{"type":"string"},"vpnBytesIn":{"format":"int32","type":"integer"},"vpnBytesOut":{"format":"int32","type":"integer"},"vpnClientApplication":{"type":"string"},"vpnClientCountry":{"type":"string"},"vpnClientOS":{"type":"string"},"vpnClientPublicIP":{"type":"string"},"vpnConnectionDuration":{"format":"int32","type":"integer"},"vpnConnectionProfile":{"type":"string"},"vpnGroupPolicy":{"type":"string"},"vpnSessionType":{"type":"string"}},"$$ref":"#/components/schemas/UserActivity"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Analysis"],"__originalOperationId":"deleteMultipleUserActivity","method":"delete","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/analysis/useractivity"}}