@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0053.public.ves.io.schema.shape.client_side_defense.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.client_side_defense","description":"Custom handler in Client-Side Defense microservice will forward request(s) to backend API(s)","version":""},"paths":{"/api/shape/csd/namespaces/system/init":{"post":{"summary":"Enable Client-Side Defense","description":"Enable Client-Side Defense feature for the tenant","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.Init","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseInitResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseInitRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-init"},"x-ves-deprecated":"Use Subscribe API","x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.Init"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/detected_domains":{"get":{"summary":"Get Detected Domains","description":"Get the detected domains data for the tenant","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetDetectedDomains","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetDetectedDomainsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"duration","description":"x-example: \"15\"\nLength in Days to fetch domain","in":"query","required":false,"x-displayname":"Duration days","schema":{"type":"string"}},{"name":"locations","description":"x-example: \"location1.com,location2.com\"\nList of locations if backend needs to filter with locations passed","in":"query","required":false,"x-displayname":"Locations","schema":{"type":"string"}},{"name":"risk","description":"x-example: \"high\"\nGet the list of high risk domains, all domains is by default","in":"query","required":false,"x-displayname":"Risk","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getdetecteddomains"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetDetectedDomains"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/domain_details":{"get":{"summary":"Get Domain Details","description":"Get the details of the domain provided","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetDomainDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetDomainDetailsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"x-required\nx-example: \"domain.com\"\nName of the domain to get the details","in":"query","required":false,"x-displayname":"Domain Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getdomaindetails"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetDomainDetails"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/formFields":{"get":{"summary":"List All Form Fields with GET method","description":"List form fields for all the scripts depending on start time and end time with GET method","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsGet","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListFormFieldsGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listformfieldsget"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsGet"},"post":{"summary":"List All Form Fields","description":"List form fields for all the scripts depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFields","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListFormFieldsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListFormFieldsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listformfields"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFields"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/formFields/analysis":{"post":{"summary":"Update FormField Analysis","description":"Mark / unmark field sensitivity by customer","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateFieldAnalysis","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateFieldAnalysisResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateFieldAnalysisRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-updatefieldanalysis"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateFieldAnalysis"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/formFields/{id}":{"get":{"summary":"Get Form Field","description":"Get form field for the name of the form field","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetFormField","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetFormFieldResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"f-ssabcde\"\nID of the form field","in":"path","required":true,"x-displayname":"ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getformfield"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetFormField"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/js_configuration":{"get":{"summary":"Get JS Injection Configuration","description":"Get JS Injection Configuration for this tenant","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetJsInjectionConfiguration","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetJsInjectionConfigurationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"x-example: \"scriptTag\"\nFormat we want the script to be returned in","in":"query","required":false,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getjsinjectionconfiguration"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetJsInjectionConfiguration"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/script/justification/{justification_id}":{"delete":{"summary":"Delete Script Justification","description":"Delete the specified script justification","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.DeleteScriptJustification","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseDeleteScriptJustificationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"justification_id","description":"justification_id\n\nx-example: \"j-1234567\"\nId of the justification","in":"path","required":true,"x-displayname":"Justification Id","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-deletescriptjustification"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.DeleteScriptJustification"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts":{"get":{"summary":"List Scripts","description":"List all the scripts for the tenant depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListScriptsLegacy","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListScriptsLegacyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch scripts whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch scripts whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}},{"name":"page_size","description":"x-example: \"500\"\nThe maximum number of scripts to return per page","in":"query","required":false,"x-displayname":"Page Size","schema":{"type":"integer","format":"int32"}},{"name":"page_number","description":"x-example: \"10\"\nOne-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified","in":"query","required":false,"x-displayname":"Page Number","schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"x-example: \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"\npage_token is the value of ListScriptsResponse.next_page_token from previous request","in":"query","required":false,"x-displayname":"Page Token","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listscriptslegacy"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListScriptsLegacy"},"post":{"summary":"List Scripts","description":"List all the scripts for the tenant depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListScripts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListScriptsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListScriptsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listscripts"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListScripts"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{id}/behaviors":{"get":{"summary":"List Behaviors By Script","description":"List all the behaviors for a script depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListBehaviorsByScript","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListBehaviorsByScriptResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"s-1234567\"\nScript id","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}},{"name":"type","description":"x-example: \"NEW\"\nx-required\nFilter based on type of behaviors\n\n - NEW: NEW\n\nx-example: \"NEW\"\nNew Behaviors\n - ALL: ALL\n\nx-example: \"ALL\"\nAll Behaviors","in":"query","required":false,"x-displayname":"ALL","schema":{"type":"string","enum":["NEW","ALL"],"default":"NEW"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listbehaviorsbyscript"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListBehaviorsByScript"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{id}/dashboard":{"get":{"summary":"Get Script Overview","description":"Get script overview data for a script depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptOverview","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetScriptOverviewResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"s-1234567\"\nScript id","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}},{"name":"type","description":"x-example: \"NEW\"\nx-required\nFilter events based on type of behaviors\n\n - NEW: NEW\n\nx-example: \"NEW\"\nNew Behaviors\n - ALL: ALL\n\nx-example: \"ALL\"\nAll Behaviors","in":"query","required":false,"x-displayname":"ALL","schema":{"type":"string","enum":["NEW","ALL"],"default":"NEW"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getscriptoverview"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptOverview"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{id}/formFields":{"get":{"summary":"List Form Fields By Script","description":"List all the form fields for a script depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsByScript","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListFormFieldsByScriptResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"s-1234567\"\nscript id","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listformfieldsbyscript"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsByScript"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{id}/networkInteractions":{"get":{"summary":"List Network Interactions By Script","description":"List all the network interactions for a script depending on start time and end time","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListNetworkInteractionsByScript","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListNetworkInteractionsByScriptResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"s-1234567\"\nscript id","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"1570194000\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch network interactions whose timestamp >= start_time","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570194300\"\nx-required\nformat: unix epoch timestamp in seconds\nfetch network interactions whose timestamp <= end_time","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listnetworkinteractionsbyscript"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListNetworkInteractionsByScript"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{id}/readStatus":{"post":{"summary":"Update Script FormFields ReadStatus","description":"Allow / block script from reading form fields","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptReadStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateScriptReadStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"s-1234567\"\nScript id","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateScriptReadStatusRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-updatescriptreadstatus"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptReadStatus"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/affectedUsers":{"post":{"summary":"List Affected Users","description":"List affected users who have loaded this particular script","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.ListAffectedUsers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListAffectedUsersResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"script_id","description":"script_id\n\nx-example: \"s-1234567\"\nx-required\nID of the script","in":"path","required":true,"x-displayname":"Script ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseListAffectedUsersRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-listaffectedusers"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.ListAffectedUsers"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/justification":{"post":{"summary":"Update Script Justification","description":"Update justification for script found","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptJustification","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateScriptJustificationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"script_id","description":"script_id\n\nx-example: \"s-1234567\"\nx-required\nId of the script","in":"path","required":true,"x-displayname":"Script Id","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateScriptJustificationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-updatescriptjustification"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptJustification"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/status":{"get":{"summary":"Get Status","description":"Get Client-Side Defense status for the tenant","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getstatus"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetStatus"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/summary":{"get":{"summary":"Get Summary","description":"Get summay details for a given customer","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.GetSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseGetSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-getsummary"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.GetSummary"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/testjs":{"post":{"summary":"Test JS","description":"Validate JS script tag injection in the target url","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.TestJS","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseTestJSResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseTestJSRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-testjs"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.TestJS"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/csd/namespaces/{namespace}/update_domains":{"post":{"summary":"Update Domains","description":"Update domain from mitigated domains to allowed domains and vice versa","operationId":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateDomains","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateDomainsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_side_defenseUpdateDomainsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-client_side_defense-customapi-updatedomains"},"x-ves-proto-rpc":"ves.io.schema.shape.client_side_defense.CustomAPI.UpdateDomains"},"x-displayname":"Client-Side Defense APIs","x-ves-proto-service":"ves.io.schema.shape.client_side_defense.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Client-Side Defense APIs","x-ves-proto-package":"ves.io.schema.shape.client_side_defense","components":{"schemas":{"client_side_defenseACTION_TYPE":{"type":"string","description":"x-example: \"BLOCK\"\nType of Action\n\n - BLOCK: BLOCK\n\nx-example: \"BLOCK\"\nBlock Form Field Read\n - ALLOW: ALLOW\n\nx-example: \"ALLOW\"\nAllow Form Field Read","title":"ACTION_TYPE","enum":["BLOCK","ALLOW"],"default":"BLOCK","x-displayname":"Action type","x-ves-proto-enum":"ves.io.schema.shape.client_side_defense.ACTION_TYPE"},"client_side_defenseANALYSIS_TYPE":{"type":"string","description":"x-example: \"SENSITIVE\"\nType of Analysis\n\n - SENSITIVE: SENSITIVE\n\nx-example: \"SENSITIVE\"\nMark field as sensitive\n - NOT_SENSITIVE: NOT_SENSITIVE\n\nx-example: \"NOT_SENSITIVE\"\nMark field as not sensitive","title":"ANALYSIS_TYPE","enum":["SENSITIVE","NOT_SENSITIVE"],"default":"SENSITIVE","x-displayname":"Analysis type","x-ves-proto-enum":"ves.io.schema.shape.client_side_defense.ANALYSIS_TYPE"},"client_side_defenseAddToAllowedDomains":{"type":"object","description":"Add To Allowed Domains","title":"AddToAllowedDomains","x-displayname":"Add To Allowed Domains","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AddToAllowedDomains","properties":{"domains":{"type":"array","description":" Domains are added to allowed list\n\nExample: ` \"['company1.com', 'company2.com']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.hostname: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n","title":"Domains","items":{"type":"string","maxLength":256},"x-displayname":"Domains","x-ves-example":"['company1.com', 'company2.com']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.hostname":"true","ves.io.schema.rules.repeated.items.string.max_len":"256"}}}},"client_side_defenseAddToMitigatedDomains":{"type":"object","description":"Add To Mitigated Domains","title":"AddToMitigatedDomains","x-displayname":"Add To Mitigated Domains","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AddToMitigatedDomains","properties":{"domains":{"type":"array","description":" Domains are added to mitigated list\n\nExample: ` \"['example1.com', 'example2.com']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.hostname: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n","title":"Domains","items":{"type":"string","maxLength":256},"x-displayname":"Domains","x-ves-example":"['example1.com', 'example2.com']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.hostname":"true","ves.io.schema.rules.repeated.items.string.max_len":"256"}}}},"client_side_defenseAffectedUser":{"type":"object","description":"Information about the affected user","title":"AffectedUser","x-displayname":"Affected User","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AffectedUser","properties":{"channel":{"type":"string","description":" Channel of access to script by affected user\n\nExample: ` \"Web\"`","title":"channel","x-displayname":"Channel","x-ves-example":"Web"},"device_id":{"type":"string","description":" Device ID of the affected user\n\nExample: ` \"AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==\"`","title":"device_id","x-displayname":"Device ID","x-ves-example":"AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ=="},"geolocation":{"type":"string","description":" Geolocation of the affected user\n\nExample: ` \"Singapore\"`","title":"Geolocation","x-displayname":"Geolocation","x-ves-example":"Singapore"},"ip_address":{"type":"string","description":" IP address of the affected user\n\nExample: ` \"236.171.56.51\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"ip_address","x-displayname":"IP Address","x-ves-example":"236.171.56.51","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}},"last_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last seen time\n\nExample: ` \"1650603600000\"`","title":"last_seen","x-displayname":"Last Seen","x-ves-example":"1650603600000"},"user_agent":{"type":"string","description":" User agent of affected user\n\nExample: ` \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36\"`","title":"user_agent","x-displayname":"User Agent","x-ves-example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36"}}},"client_side_defenseAffectedUserDeviceIDFilter":{"type":"object","description":"Filter by affected user device ID","title":"AffectedUserDeviceIDFilter","x-displayname":"Affected User Device ID Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AffectedUserDeviceIDFilter","properties":{"device_ids":{"type":"array","description":" An unordered list of device IDs\n\nExample: ` \"['AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"device_ids","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Device IDs","x-ves-example":"['AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseAffectedUserFilters":{"type":"object","description":"ListAffectedUsers API query filters","title":"AffectedUserFilters","x-displayname":"Affected User Filters","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AffectedUserFilters","properties":{"affected_user_device_id_filter":{"$ref":"#/components/schemas/client_side_defenseAffectedUserDeviceIDFilter"},"affected_user_geolocation_filter":{"$ref":"#/components/schemas/client_side_defenseAffectedUserGeolocationFilter"},"affected_user_ip_address_filter":{"$ref":"#/components/schemas/client_side_defenseAffectedUserIPAddressFilter"}}},"client_side_defenseAffectedUserGeolocationFilter":{"type":"object","description":"Filter by affected user geolocation","title":"AffectedUserGeolocationFilter","x-displayname":"Affected User Geolocation Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AffectedUserGeolocationFilter","properties":{"geolocations":{"type":"array","description":" An unordered list of geolocations\n\nExample: ` \"['Singapore']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"geolocations","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Geolocations","x-ves-example":"['Singapore']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseAffectedUserIPAddressFilter":{"type":"object","description":"Filter by affected user IP address","title":"AffectedUserIPAddressFilter","x-displayname":"Affected User IP Address Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.AffectedUserIPAddressFilter","properties":{"ip_addresses":{"type":"array","description":" An unordered list of IP addresses\n\nExample: ` \"['236.171.56.51']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ip: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"ip_addresses","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"IP Addresses","x-ves-example":"['236.171.56.51']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ip":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseAnalysis":{"type":"object","description":"Analysis of the form field by Client Side Defense","title":"Analysis","x-displayname":"Analysis","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Analysis","properties":{"updated_by":{"type":"string","description":" Updated by\n\nExample: ` \"system\"`","title":"updated_by","x-displayname":"Updated By","x-ves-example":"system"},"value":{"type":"string","description":" Value of the form field analysed by Client side defense\n\nExample: ` \"Sensitive\"`","title":"value","x-displayname":"Value","x-ves-example":"Sensitive"}}},"client_side_defenseBEHAVIOR_TYPE":{"type":"string","description":"x-displayName: \"Behavior type\"\nx-example: \"NEW\"\nType of Behavior\n\n - NEW: NEW\n\nx-displayName: \"NEW\"\nx-example: \"NEW\"\nNew Behaviors\n - ALL: ALL\n\nx-displayName: \"ALL\"\nx-example: \"ALL\"\nAll Behaviors","title":"BEHAVIOR_TYPE","enum":["NEW","ALL"],"default":"NEW"},"client_side_defenseBehaviorByScript":{"type":"object","description":"Behavior info","title":"BehaviorByScript","x-displayname":"Behavior","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.BehaviorByScript","properties":{"category":{"type":"string","description":" Category of the behavior\n\nExample: ` \"Network\"`","title":"category","x-displayname":"Category","x-ves-example":"Network"},"first_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First seen time\n\nExample: ` \"1650603600000\"`","title":"first_seen","x-displayname":"First Seen","x-ves-example":"1650603600000"},"last_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last seen time\n\nExample: ` \"1650603600000\"`","title":"last_seen","x-displayname":"Last Seen","x-ves-example":"1650603600000"},"name":{"type":"string","description":" Name of the behavior\n\nExample: ` \"marvel.com\"`","title":"name","x-displayname":"Name","x-ves-example":"marvel.com"},"recommendation":{"type":"string","description":" Recommendation of the behavior by Client Side Defense\n\nExample: ` \"We recommend checking the script's source/destination and consider immediate removal of the script\"`","title":"recommendation","x-displayname":"Recommendation","x-ves-example":"We recommend checking the script's source/destination and consider immediate removal of the script"},"risk_level":{"type":"string","description":" Risk level of the element read by script\n\nExample: ` \"High Risk\"`","title":"risk_level","x-displayname":"Risk Level","x-ves-example":"High Risk"},"users_affected":{"type":"integer","description":" Users affected by the behavior of the script\n\nExample: ` 32`","title":"users_affected","format":"int32","x-displayname":"Users Affected"}}},"client_side_defenseDeleteScriptJustificationResponse":{"type":"object","description":"Response to delete script justification","title":"DeleteScriptJustificationResponse","x-displayname":"Delete script justification response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.DeleteScriptJustificationResponse"},"client_side_defenseDeviceIDFilter":{"type":"object","description":"Query Filter by device id filter strings","title":"Device ID Filter","x-displayname":"Device ID Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.DeviceIDFilter","properties":{"device_id_strings":{"type":"array","description":" An unordered list of Device ID strings\n\nExample: ` \"['device123']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Device ID Strings","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Device ID Strings","x-ves-example":"['device123']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseDomainDetails":{"type":"object","description":"Client-Side defense usage details per domain.","title":"DomainDetails","x-displayname":"Domain details","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.DomainDetails","properties":{"actionDate":{"type":"string","description":" Date when an action was required\n\nExample: ` 1629839825497`","title":"ActionDate","format":"int64","x-displayname":"Action Date"},"category":{"type":"string","description":" Human readable category description\n\nExample: ` \"Web hosting\"`","title":"Category","x-displayname":"Category","x-ves-example":"Web hosting"},"domain":{"type":"string","description":" Name of the domain the details are for\n\nExample: ` \"www.some-domain.com\"`","title":"Domain","x-displayname":"Domain","x-ves-example":"www.some-domain.com"},"firstSeenDate":{"type":"string","description":" Date the domain was seen the first time (data was collected for the site)\n\nExample: ` 1629839825497`","title":"FirstSeenDate","format":"int64","x-displayname":"First Seen Date"},"latestSeenDate":{"type":"string","description":" Date the domain was seen the latest time (last time data was collected for the site)\n\nExample: ` 1629839825497`","title":"latestSeenDate","format":"int64","x-displayname":"Latest Seen Date"},"locations":{"type":"array","description":" List of location -> scripts data\n Location will returned only when risk filter is applied","title":"Locations","items":{"$ref":"#/components/schemas/shapeclient_side_defenseLocation"},"x-displayname":"Locations"},"riskReason":{"type":"array","description":" List of risk reasons in a human readable form\n\nExample: ` \"['Unusual number of DNS record','Has less Https certificate related info']\"`","title":"RiskReasons","items":{"type":"string"},"x-displayname":"Risk Reasons","x-ves-example":"['Unusual number of DNS record','Has less Https certificate related info']"},"riskScore":{"type":"integer","description":" Domain reputation score - the bigger the better\n\nExample: ` \"10\"`","title":"ReputationScore","format":"int32","x-displayname":"Reputation Score","x-ves-example":"10"},"status":{"type":"string","description":" Human readable status description\n\nExample: ` \"Action Needed\"`","title":"Status","x-displayname":"Status","x-ves-example":"Action Needed"}}},"client_side_defenseDomainSummary":{"type":"object","description":"Collection of aggregated details","title":"DomainSummary","x-displayname":"Domain Summary","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.DomainSummary","properties":{"actionNeededCount":{"$ref":"#/components/schemas/client_side_defenseUpdatedCount"},"allowedDomains":{"$ref":"#/components/schemas/client_side_defenseUpdatedCount"},"mitigatedDomains":{"$ref":"#/components/schemas/client_side_defenseUpdatedCount"},"totalDomains":{"$ref":"#/components/schemas/client_side_defenseUpdatedCount"}}},"client_side_defenseEnterpriseInfo":{"type":"object","description":"Additional Information about the Enterprise","title":"EnterpriseInfo","x-displayname":"Enterprise Info","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.EnterpriseInfo","properties":{"transactionCount":{"type":"integer","description":" Usage transaction count\n\nExample: ` 100`","title":"transactionCount","format":"int32","x-displayname":"transactionCount"}}},"client_side_defenseEvent":{"type":"object","description":"Event Info","title":"Event","x-displayname":"Event","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Event","properties":{"date":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Date of the event\n\nExample: ` \"1650603600000\"`","title":"date","x-displayname":"Date","x-ves-example":"1650603600000"},"existing_behavior":{"type":"integer","description":" Number of existing behaviors\n\nExample: ` 15`","title":"existing_behavior","format":"int32","x-displayname":"Existing Behavior"},"new_behavior":{"type":"integer","description":" Number of new behaviors\n\nExample: ` 12`","title":"new_behavior","format":"int32","x-displayname":"New Behavior"}}},"client_side_defenseFilterOperator":{"type":"string","description":"x-example: \"IN or NOT_IN\"\nOperator for query filter\n\n - IN: Filter Operator\n\nSpecifies that query result includes filter values","title":"Filter Operator","enum":["IN"],"default":"IN","x-displayname":"Filter Operator","x-ves-proto-enum":"ves.io.schema.shape.client_side_defense.FilterOperator"},"client_side_defenseFilters":{"type":"object","description":"ListScripts API query filters","title":"Filters","x-displayname":"Filters","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Filters","properties":{"device_id_filter":{"$ref":"#/components/schemas/client_side_defenseDeviceIDFilter"},"ip_filter":{"$ref":"#/components/schemas/client_side_defenseIPFilter"},"risk_level_filter":{"$ref":"#/components/schemas/client_side_defenseRiskLevelFilter"},"script_name_filter":{"$ref":"#/components/schemas/client_side_defenseScriptNameFilter"},"script_status_filter":{"$ref":"#/components/schemas/client_side_defenseScriptStatusFilter"}}},"client_side_defenseFormField":{"type":"object","description":"Form field info of all the scripts","title":"FormField","x-displayname":"Form Field","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.FormField","properties":{"analysis":{"$ref":"#/components/schemas/client_side_defenseAnalysis"},"associated_scripts":{"type":"array","description":" Associated script which read the form field first\n\nExample: ` \"['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']\"`","title":"associated_scripts","items":{"type":"string"},"x-displayname":"Associated Scripts","x-ves-example":"['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']"},"first_read":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First read time\n\nExample: ` \"1650603600000\"`","title":"first_read","x-displayname":"First Read","x-ves-example":"1650603600000"},"id":{"type":"string","description":" ID of the form field\n\nExample: ` \"f-ssabcde\"`","title":"id","x-displayname":"ID","x-ves-example":"f-ssabcde"},"last_read":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last read time\n\nExample: ` \"1650603600000\"`","title":"last_read","x-displayname":"Last Read","x-ves-example":"1650603600000"},"locations":{"type":"array","description":" Locations where the form field is present\n\nExample: ` \"['marvel.com','jsp.com']\"`","title":"locations","items":{"type":"string"},"x-displayname":"Locations","x-ves-example":"['marvel.com','jsp.com']"},"name":{"type":"string","description":" Name of the form field\n\nExample: ` \"username\"`","title":"name","x-displayname":"Name","x-ves-example":"username"}}},"client_side_defenseFormFieldAnalysisFilter":{"type":"object","description":"Query Filter by form field analysis filter strings","title":"Form Field Analysis Filter","x-displayname":"Form Field Analysis Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.FormFieldAnalysisFilter","properties":{"analysis_strings":{"type":"array","description":" An unordered list of script status strings\n\nExample: ` \"['Sensitive (by System)', 'Not Sensitive (by user)', 'Not Sensitive (by system)']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 128\n  ves.io.schema.rules.repeated.max_items: 10\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Script Status Strings","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":128},"x-displayname":"Form Field Analysis Strings","x-ves-example":"['Sensitive (by System)', 'Not Sensitive (by user)', 'Not Sensitive (by system)']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"128","ves.io.schema.rules.repeated.max_items":"10","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseFormFieldByScript":{"type":"object","description":"Form field information filtered by script","title":"FormFieldByScript","x-displayname":"Form field by script","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.FormFieldByScript","properties":{"first_read":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First read time of the form field by the script\n\nExample: ` \"1650603600000\"`","title":"first_read","x-displayname":"First Read","x-ves-example":"1650603600000"},"id":{"type":"string","description":" ID of the form field\n\nExample: ` \"f-ssabcde\"`","title":"id","x-displayname":"ID","x-ves-example":"f-ssabcde"},"last_read":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last read time of the form field by the script\n\nExample: ` \"1650603600000\"`","title":"last_read","x-displayname":"Last Read","x-ves-example":"1650603600000"},"name":{"type":"string","description":" Name of the form field\n\nExample: ` \"password\"`","title":"name","x-displayname":"Name","x-ves-example":"password"},"risk_level":{"type":"string","description":" Risk level of the form field read by script\n\nExample: ` \"High Risk\"`","title":"risk_level","x-displayname":"Risk Level","x-ves-example":"High Risk"}}},"client_side_defenseFormFieldNameFilter":{"type":"object","description":"Query Filter by form field name filter strings","title":"Form Field Name Filter","x-displayname":"Form Field Name Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.FormFieldNameFilter","properties":{"name_strings":{"type":"array","description":" An unordered list of form field name strings\n\nExample: ` \"['lname']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Script Name Strings","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Form Field Name Strings","x-ves-example":"['lname']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseFormFieldsFilters":{"type":"object","description":"ListFormFields API query filters","title":"Filters","x-displayname":"Filters","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.FormFieldsFilters","properties":{"form_field_analysis_filter":{"$ref":"#/components/schemas/client_side_defenseFormFieldAnalysisFilter"},"form_field_name_filter":{"$ref":"#/components/schemas/client_side_defenseFormFieldNameFilter"}}},"client_side_defenseGetDetectedDomainsResponse":{"type":"object","description":"Get detected domains monitoring data","title":"GetDetectedDomainsResponse","x-displayname":"Get Domains Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetDetectedDomainsResponse","properties":{"customer":{"$ref":"#/components/schemas/client_side_defenseEnterpriseInfo"},"domainSummary":{"$ref":"#/components/schemas/client_side_defenseDomainSummary"},"domainsList":{"type":"array","description":" Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated)","title":"DomainsList","items":{"$ref":"#/components/schemas/client_side_defenseDomainDetails"},"x-displayname":"Domains List"},"locationList":{"type":"object","description":" \"location URL -> protection flag\" map\n\nExample: ` \"['www.some-domain.com/reset-password'true,'www.some-domain.com/login': false]\"`","title":"LocationList","x-displayname":"Location list","x-ves-example":"['www.some-domain.com/reset-password': true,'www.some-domain.com/login': false]"}}},"client_side_defenseGetDomainDetailsResponse":{"type":"object","description":"Get domain details for the domain","title":"GetDomainDetailsResponse","x-displayname":"Get Domains Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetDomainDetailsResponse","properties":{"actionDate":{"type":"string","description":" Date when an action was required\n\nExample: ` 1629839825497`","title":"ActionDate","format":"int64","x-displayname":"Action Date"},"category":{"type":"string","description":" Human readable category description\n\nExample: ` \"Web hosting\"`","title":"Category","x-displayname":"Category","x-ves-example":"Web hosting"},"domain":{"type":"string","description":" Name of the domain the details are for\n\nExample: ` \"www.some-domain.com\"`","title":"Domain","x-displayname":"Domain","x-ves-example":"www.some-domain.com"},"firstSeenDate":{"type":"string","description":" Date the domain was seen the first time (data was collected for the site)\n\nExample: ` 1629839825497`","title":"FirstSeenDate","format":"int64","x-displayname":"First Seen Date"},"latestSeenDate":{"type":"string","description":" Date the domain was seen the latest time (last time data was collected for the site)\n\nExample: ` 1629839825497`","title":"latestSeenDate","format":"int64","x-displayname":"Latest Seen Date"},"locations":{"type":"array","description":" List of location -> scripts data\n Location will returned only when risk filter is applied","title":"Locations","items":{"$ref":"#/components/schemas/shapeclient_side_defenseLocation"},"x-displayname":"Locations"},"riskReason":{"type":"array","description":" List of risk reasons in a human readable form\n\nExample: ` \"['Unusual number of DNS record','Has less Https certificate related info']\"`","title":"RiskReasons","items":{"type":"string"},"x-displayname":"Risk Reasons","x-ves-example":"['Unusual number of DNS record','Has less Https certificate related info']"},"riskScore":{"type":"integer","description":" Domain reputation score - the bigger the better\n\nExample: ` \"10\"`","title":"ReputationScore","format":"int32","x-displayname":"Reputation Score","x-ves-example":"10"},"status":{"type":"string","description":" Human readable status description\n\nExample: ` \"Action Needed\"`","title":"Status","x-displayname":"Status","x-ves-example":"Action Needed"}}},"client_side_defenseGetFormFieldResponse":{"type":"object","description":"Response to get form field","title":"GetFormFieldResponse","x-displayname":"Get Form Field Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetFormFieldResponse","properties":{"associated_scripts":{"type":"array","description":" Associated scripts of the form field\n\nExample: ` \"['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']\"`","title":"associated_scripts","items":{"type":"string"},"x-displayname":"Associated Scripts","x-ves-example":"['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']"},"id":{"type":"string","description":" ID of the form field\n\nExample: ` \"f-ssabcde\"`","title":"id","x-displayname":"ID","x-ves-example":"f-ssabcde"},"name":{"type":"string","description":" Name of the form field\n\nExample: ` \"username\"`","title":"name","x-displayname":"Name","x-ves-example":"username"}}},"client_side_defenseGetJsInjectionConfigurationResponse":{"type":"object","description":"Response to a get injection script request","title":"GetJsInjectionConfigurationResponse","x-displayname":"Get injection configuration response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetJsInjectionConfigurationResponse","properties":{"scriptTag":{"type":"string","description":" Javascript tag injected to URL pathes that user configures\n\nExample: ` \"<script type=”text/javascript” src=”https://dip.zeronaught.com/js/0987654.js”></script>\"`","title":"Script Tag","x-displayname":"Script Tag","x-ves-example":"<script type=”text/javascript” src=”https://dip.zeronaught.com/js/0987654.js”></script>"}}},"client_side_defenseGetScriptOverviewResponse":{"type":"object","description":"Response to get script overview","title":"GetScriptOverviewResponse","x-displayname":"Get script overview response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetScriptOverviewResponse","properties":{"events":{"type":"array","description":" Event info of the dashboard of the script","title":"events","items":{"$ref":"#/components/schemas/client_side_defenseEvent"},"x-displayname":"Events"},"summary":{"$ref":"#/components/schemas/client_side_defenseSummary"}}},"client_side_defenseGetStatusResponse":{"type":"object","description":"Get status of Client-Side Defense Configuration","title":"GetStatusResponse","x-displayname":"Get Config Status Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetStatusResponse","properties":{"isConfigured":{"type":"boolean","description":" Client-Side defense service is configured or not\n\nExample: ` true`","title":"isConfigured","format":"boolean","x-displayname":"isConfigured"},"isEnabled":{"type":"boolean","description":" Client-Side defense service is enabled or not\n\nExample: ` true`","title":"isEnabled","format":"boolean","x-displayname":"isEnabled"}}},"client_side_defenseGetSummaryResponse":{"type":"object","description":"Response to get summary","title":"GetSummaryResponse","x-displayname":"Get Summary Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.GetSummaryResponse","properties":{"blocked_scripts":{"type":"integer","description":" Number of blocked scripts\n\nExample: ` 11`","title":"blocked_scripts","format":"int32","x-displayname":"Blocked Scripts count"},"mitigated_domains":{"type":"integer","description":" Number of mitigated domains\n\nExample: ` 5`","title":"mitigated_domains","format":"int32","x-displayname":"Mitigated Domains count"},"suspicious_scripts":{"type":"integer","description":" Count of the suspicious scripts\n\nExample: ` 10`","title":"suspicious_scripts","format":"int32","x-displayname":"High Risk scripts"}}},"client_side_defenseIPFilter":{"type":"object","description":"Query Filter by ip address filter strings","title":"IP Filter","x-displayname":"IP Address Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.IPFilter","properties":{"ip_strings":{"type":"array","description":" An unordered list of ip address strings\n\nExample: ` \"['192.168.1.1']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ip: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"IP Strings","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"IP Address Strings","x-ves-example":"['192.168.1.1']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ip":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"}}},"client_side_defenseInitRequest":{"type":"object","description":"Any payload to be passed on the Provision API","title":"InitRequest","x-displayname":"Enable Client-Side Defense Request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.InitRequest","properties":{"email":{"type":"string","description":" Email Address for Notifications\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.email: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"Email Address for Notifications","x-displayname":"Email Address for Notifications","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.email":"true","ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"serviceType":{"type":"string","description":" CSD service type\n\nExample: ` \"csd-service\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"csd-service\\\"]\n","title":"Service Type","x-displayname":"Service Type","x-ves-example":"csd-service","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"csd-service\\\"]"}}}},"client_side_defenseInitResponse":{"type":"object","description":"Any payload to be return by Provision API","title":"InitResponse","x-displayname":"Enable Client-Side Defense Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.InitResponse","properties":{"isConfigured":{"type":"boolean","description":" Client-Side defense service is configured\n\nExample: ` true`","title":"IsConfigured","format":"boolean","x-displayname":"Is Configured"}}},"client_side_defenseJustification":{"type":"object","description":"User-provided script justification","title":"Justification","x-displayname":"Script Justification","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Justification","properties":{"create_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n Time that the justification was entered\n\nExample: ` \"1570194000\"`","title":"create_time","x-displayname":"Creation Time","x-ves-example":"1570194000"},"justification":{"type":"string","description":" Script Justification\n\nExample: ` \"Blocking script due to network callout to malicious domain.\"`","title":"justification","x-displayname":"Script Justification","x-ves-example":"Blocking script due to network callout to malicious domain."},"justification_id":{"type":"string","description":" Id of the justification\n\nExample: ` \"j-1234567\"`","title":"justification_id","x-displayname":"Justification Id","x-ves-example":"j-1234567"},"user_id":{"type":"string","description":" Id of the justification creator\n\nExample: ` \"u-1234567\"`","title":"user_id","x-displayname":"User Id","x-ves-example":"u-1234567"}}},"client_side_defenseListAffectedUsersRequest":{"type":"object","description":"Request to list affected users who have loaded this particular script","title":"ListAffectedUsersRequest","x-displayname":"List Affected Users Request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListAffectedUsersRequest","properties":{"end_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch affected users whose last seen time <= end_time\n\nExample: ` \"1570194300\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.query_time: true\n","title":"end_time","x-displayname":"End Time","x-ves-example":"1570194300","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.query_time":"true"}},"filters":{"$ref":"#/components/schemas/client_side_defenseAffectedUserFilters"},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"page_number":{"type":"integer","description":" One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1"}},"page_size":{"type":"integer","description":" The maximum number of affected users to return per page\n\nExample: ` \"500\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 1000\n","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"1000"}},"page_token":{"type":"string","description":" page_token is the value of ListAffectedUsersResponse.next_page_token from previous request\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n","title":"page_token","maxLength":512,"x-displayname":"Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512"}},"script_id":{"type":"string","description":" ID of the script\n\nExample: ` \"s-1234567\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"script_id","x-displayname":"Script ID","x-ves-example":"s-1234567","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"sorts":{"type":"array","description":" Additional sort criteria","title":"sorts","items":{"$ref":"#/components/schemas/client_side_defenseSort"},"x-displayname":"Sorts"},"start_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch affected users whose last seen time >= start_time\n\nExample: ` \"1570194000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.query_time: true\n","title":"start_time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.query_time":"true"}}}},"client_side_defenseListAffectedUsersResponse":{"type":"object","description":"Response to list affected users who have loaded this particular script","title":"ListAffectedUsersResponse","x-displayname":"List Affected Users Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListAffectedUsersResponse","properties":{"affected_users":{"type":"array","description":" List of affected users","title":"affected_users","items":{"$ref":"#/components/schemas/client_side_defenseAffectedUser"},"x-displayname":"Affected Users"},"next_page_token":{"type":"string","description":" Opaque value passed back alone with the additional calls. All filtering will stay the same\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"next_page_token","x-displayname":"Next Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"page_number":{"type":"integer","description":" One-indexed page number\n\nExample: ` \"2\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"2"},"page_size":{"type":"integer","description":" The maximum number of affected users to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"total_count":{"type":"integer","description":" Total count of affected users available at time of query, and subject to change across queries\n\nExample: ` \"1000\"`","title":"total_count","format":"int32","x-displayname":"Total Count","x-ves-example":"1000"},"total_pages":{"type":"integer","description":" Total number of pages available depending upon requested page_size\n\nExample: ` \"2\"`","title":"total_pages","format":"int32","x-displayname":"Total Pages","x-ves-example":"2"}}},"client_side_defenseListBehaviorsByScriptResponse":{"type":"object","description":"Response to list behaviors by script","title":"ListBehaviorsByScriptResponse","x-displayname":"List behaviors by script response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListBehaviorsByScriptResponse","properties":{"behaviors":{"type":"array","description":" List of behaviors depending upon filter.","title":"behaviors","items":{"$ref":"#/components/schemas/client_side_defenseBehaviorByScript"},"x-displayname":"Behaviors"},"total_size":{"type":"integer","description":" Total size of scripts\n\nExample: ` 10`","title":"total_size","format":"int32","x-displayname":"Total Size"}}},"client_side_defenseListFormFieldsByScriptResponse":{"type":"object","description":"Response to list form fields for input script","title":"ListFormFieldsByScriptResponse","x-displayname":"List form fields by script response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListFormFieldsByScriptResponse","properties":{"form_fields":{"type":"array","description":" List of form fields for input script depending on start time and end time","title":"form_fields","items":{"$ref":"#/components/schemas/client_side_defenseFormFieldByScript"},"x-displayname":"Form Fields"},"status":{"type":"string","description":" Status of the script\n\nExample: ` \"Blocked Read\"`","title":"status","x-displayname":"Status","x-ves-example":"Blocked Read"},"total_size":{"type":"integer","description":" Total size of scripts\n\nExample: ` 10`","title":"total_size","format":"int32","x-displayname":"Total Size"}}},"client_side_defenseListFormFieldsGetResponse":{"type":"object","description":"Response to list form fields of all the scripts with GET method","title":"ListFormFieldsGetResponse","x-displayname":"List form fields response with GET method","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListFormFieldsGetResponse","properties":{"form_fields":{"type":"array","description":" List of form fields for all the scripts","title":"form_fields","items":{"$ref":"#/components/schemas/client_side_defenseFormField"},"x-displayname":"Form Fields"},"total_size":{"type":"integer","description":" Total size of scripts\n\nExample: ` 10`","title":"total_size","format":"int32","x-displayname":"Total Size"}}},"client_side_defenseListFormFieldsRequest":{"type":"object","description":"Request to list form fields of all the scripts","title":"ListFormFieldsRequest","x-displayname":"List form fields request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListFormFieldsRequest","properties":{"end_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch form fields whose timestamp <= end_time\n\nExample: ` \"1570194300\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"end_time","x-displayname":"End Time","x-ves-example":"1570194300","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"filters":{"$ref":"#/components/schemas/client_side_defenseFormFieldsFilters"},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"page_number":{"type":"integer","description":" One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified\n\nExample: ` \"10\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"10"},"page_size":{"type":"integer","description":" The maximum number of scripts to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"page_token":{"type":"string","description":" page_token is the value of ListFormFieldsResponse.next_page_token from previous request\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"page_token","x-displayname":"Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"sorts":{"type":"array","description":" Additional sort criteria","title":"sorts","items":{"$ref":"#/components/schemas/client_side_defenseSort"},"x-displayname":"Sorts"},"start_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch form fields whose timestamp >= start_time\n\nExample: ` \"1570194000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"start_time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"client_side_defenseListFormFieldsResponse":{"type":"object","description":"Response to list form fields of all the scripts","title":"ListFormFieldsResponse","x-displayname":"List form fields response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListFormFieldsResponse","properties":{"form_fields":{"type":"array","description":" List of form fields for all the scripts","title":"form_fields","items":{"$ref":"#/components/schemas/client_side_defenseFormField"},"x-displayname":"Form Fields"},"next_page_token":{"type":"string","description":" Opaque value passed back alone with the additional calls. All filtering will stay the same\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"next_page_token","x-displayname":"Next Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"page_number":{"type":"integer","description":" One-indexed page number\n\nExample: ` \"2\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"2"},"page_size":{"type":"integer","description":" The maximum number of scripts to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"total_count":{"type":"integer","description":" Total count of scripts available at time of query, and subject to change across queries\n\nExample: ` \"1000\"`","title":"total_count","format":"int32","x-displayname":"Total Count","x-ves-example":"1000"},"total_pages":{"type":"integer","description":" Total number of pages available depending upon requested page_size\n\nExample: ` \"2\"`","title":"total_pages","format":"int32","x-displayname":"Total Pages","x-ves-example":"2"},"total_size":{"type":"integer","description":" Total size of scripts\n\nExample: ` 10`","title":"total_size","format":"int32","x-displayname":"Total Size"}}},"client_side_defenseListNetworkInteractionsByScriptResponse":{"type":"object","description":"Response to list network interactions by script","title":"ListNetworkInteractionsByScriptResponse","x-displayname":"List network interactions by script response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListNetworkInteractionsByScriptResponse","properties":{"network_interactions":{"type":"array","description":" List of network interactions depending upon time filter","title":"network_interactions","items":{"$ref":"#/components/schemas/client_side_defenseNetworkInteractionByScript"},"x-displayname":"Network Interactions"},"total_size":{"type":"integer","description":" Total size of scripts\n\nExample: ` 10`","title":"total_size","format":"int32","x-displayname":"Total Size"}}},"client_side_defenseListScriptsLegacyResponse":{"type":"object","description":"Response to list scripts","title":"ListScriptsLegacyResponse","x-displayname":"List scripts response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListScriptsLegacyResponse","properties":{"next_page_token":{"type":"string","description":" Opaque value passed back alone with the additional calls. All filtering will stay the same\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"next_page_token","x-displayname":"Next Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"page_number":{"type":"integer","description":" One-indexed page number\n\nExample: ` \"2\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"2"},"page_size":{"type":"integer","description":" The maximum number of scripts to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"scripts":{"type":"array","description":" List of scripts depending upon time filter","title":"scripts","items":{"$ref":"#/components/schemas/client_side_defenseScriptInfo"},"x-displayname":"Scripts"},"total_count":{"type":"integer","description":" Total count of scripts available at time of query, and subject to change across queries\n\nExample: ` \"1000\"`","title":"total_count","format":"int32","x-displayname":"Total Count","x-ves-example":"1000"},"total_pages":{"type":"integer","description":" Total number of pages available depending upon requested page_size\n\nExample: ` \"2\"`","title":"total_pages","format":"int32","x-displayname":"Total Pages","x-ves-example":"2"}}},"client_side_defenseListScriptsRequest":{"type":"object","description":"Request to list scripts","title":"ListScriptsRequest","x-displayname":"List scripts request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListScriptsRequest","properties":{"end_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch scripts whose timestamp <= end_time\n\nExample: ` \"1570194300\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"end_time","x-displayname":"End Time","x-ves-example":"1570194300","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"filters":{"$ref":"#/components/schemas/client_side_defenseFilters"},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"page_number":{"type":"integer","description":" One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified\n\nExample: ` \"10\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"10"},"page_size":{"type":"integer","description":" The maximum number of scripts to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"page_token":{"type":"string","description":" page_token is the value of ListScriptsResponse.next_page_token from previous request\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"page_token","x-displayname":"Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"sorts":{"type":"array","description":" Additional sort criteria","title":"sorts","items":{"$ref":"#/components/schemas/client_side_defenseSort"},"x-displayname":"Sorts"},"start_time":{"type":"string","description":" format: unix epoch timestamp in seconds\n fetch scripts whose timestamp >= start_time\n\nExample: ` \"1570194000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"start_time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"client_side_defenseListScriptsResponse":{"type":"object","description":"Response to list scripts","title":"ListScriptsResponse","x-displayname":"List scripts response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ListScriptsResponse","properties":{"next_page_token":{"type":"string","description":" Opaque value passed back alone with the additional calls. All filtering will stay the same\n\nExample: ` \"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y\"`","title":"next_page_token","x-displayname":"Next Page Token","x-ves-example":"cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y"},"page_number":{"type":"integer","description":" One-indexed page number\n\nExample: ` \"2\"`","title":"page_number","format":"int32","x-displayname":"Page Number","x-ves-example":"2"},"page_size":{"type":"integer","description":" The maximum number of scripts to return per page\n\nExample: ` \"500\"`","title":"page_size","format":"int32","x-displayname":"Page Size","x-ves-example":"500"},"scripts":{"type":"array","description":" List of scripts depending upon time filter","title":"scripts","items":{"$ref":"#/components/schemas/client_side_defenseScriptInfo"},"x-displayname":"Scripts"},"total_count":{"type":"integer","description":" Total count of scripts available at time of query, and subject to change across queries\n\nExample: ` \"1000\"`","title":"total_count","format":"int32","x-displayname":"Total Count","x-ves-example":"1000"},"total_pages":{"type":"integer","description":" Total number of pages available depending upon requested page_size\n\nExample: ` \"2\"`","title":"total_pages","format":"int32","x-displayname":"Total Pages","x-ves-example":"2"}}},"client_side_defenseNetworkInteractionByScript":{"type":"object","description":"Network interaction information by script","title":"NetworkInteractionByScript","x-displayname":"Network interaction","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.NetworkInteractionByScript","properties":{"first_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First seen time\n\nExample: ` \"1650603600000\"`","title":"first_seen","x-displayname":"First Seen","x-ves-example":"1650603600000"},"last_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last seen time\n\nExample: ` \"1650609600000\"`","title":"last_seen","x-displayname":"Last Seen","x-ves-example":"1650609600000"},"name":{"type":"string","description":" Name of the domain\n\nExample: ` \"marvel.com\"`","title":"name","x-displayname":"Name","x-ves-example":"marvel.com"},"risk_level":{"type":"string","description":" Risk level of the script\n\nExample: ` \"High Risk\"`","title":"risk_level","x-displayname":"Risk Level","x-ves-example":"High Risk"},"status":{"type":"string","description":" Status of the domain\n\nExample: ` \"Added to Mitigated List\"`","title":"status","x-displayname":"Status","x-ves-example":"Added to Mitigated List"}}},"client_side_defenseRiskLevelFilter":{"type":"object","description":"Query Filter by risk level filter strings","title":"Risk Level Filter","x-displayname":"Risk Level Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.RiskLevelFilter","properties":{"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"},"risk_level_strings":{"type":"array","description":" An unordered list of risk level strings\n\nExample: ` \"['High']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 32\n  ves.io.schema.rules.repeated.max_items: 10\n  ves.io.schema.rules.repeated.unique: true\n","title":"Risk Level Strings","maxItems":10,"items":{"type":"string","maxLength":32},"x-displayname":"Risk Level Strings","x-ves-example":"['High']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"32","ves.io.schema.rules.repeated.max_items":"10","ves.io.schema.rules.repeated.unique":"true"}}}},"client_side_defenseScriptInfo":{"type":"object","description":"Script information","title":"ScriptInfo","x-displayname":"Script information","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ScriptInfo","properties":{"affected_users_count":{"type":"integer","description":" Number of affected users that loaded this script","title":"affected_users_count","format":"int32","x-displayname":"Affected Users Count"},"first_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First seen time\n\nExample: ` \"1650603600000\"`","title":"first_seen","x-displayname":"First Seen","x-ves-example":"1650603600000"},"form_fields_read":{"type":"integer","description":" Number of form fields read by script\n\nExample: ` 9`","title":"form_fields_read","format":"int32","x-displayname":"Form Fields Read"},"id":{"type":"string","description":" Id of the script\n\nExample: ` \"s-1234567\"`","title":"id","x-displayname":"Script Id","x-ves-example":"s-1234567"},"justifications":{"type":"array","description":" List of user-provided script justifications","title":"justifications","items":{"$ref":"#/components/schemas/client_side_defenseJustification"},"x-displayname":"Justifications"},"last_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last seen time\n\nExample: ` \"1650603600000\"`","title":"last_seen","x-displayname":"Last Seen","x-ves-example":"1650603600000"},"locations":{"type":"array","description":" Locations where the script was found\n\nExample: ` \"['marvel.com','jsp.com']\"`","title":"locations","items":{"type":"string"},"x-displayname":"Locations","x-ves-example":"['marvel.com','jsp.com']"},"network_interactions":{"type":"integer","description":" Number of network interactions\n\nExample: ` 7`","title":"network_interactions","format":"int32","x-displayname":"Network Interactions"},"new_behaviors":{"type":"integer","description":" Number of new behaviors of the script\n\nExample: ` 15`","title":"new_behaviors","format":"int32","x-displayname":"New Behaviors"},"risk_level":{"type":"string","description":" Risk level of the script\n\nExample: ` \"High Risk\"`","title":"risk_level","x-displayname":"Risk Level","x-ves-example":"High Risk"},"script_name":{"type":"string","description":" script detected in the webpage\n\nExample: ` \"https://www.google-analytics.com/analytics.js\"`","title":"script_name","x-displayname":"Script Name","x-ves-example":"https://www.google-analytics.com/analytics.js"},"status":{"type":"string","description":" Script Status\n\nExample: ` \"Action Needed\"`","title":"status","x-displayname":"Script Status","x-ves-example":"Action Needed"}}},"client_side_defenseScriptNameFilter":{"type":"object","description":"Query Filter by script name filter strings","title":"Script Name Filter","x-displayname":"Script Name Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ScriptNameFilter","properties":{"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"},"script_name_strings":{"type":"array","description":" An unordered list of script name strings\n\nExample: ` \"['analytics.js']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Script Name Strings","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Script Name Strings","x-ves-example":"['analytics.js']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"client_side_defenseScriptStatusFilter":{"type":"object","description":"Query Filter by script status filter strings","title":"Script Status Filter","x-displayname":"Script Status Filter","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.ScriptStatusFilter","properties":{"op":{"$ref":"#/components/schemas/client_side_defenseFilterOperator"},"script_status_strings":{"type":"array","description":" An unordered list of script status strings\n\nExample: ` \"['Action Needed', 'No Action Needed', 'No Action Needed - Resolved']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 128\n  ves.io.schema.rules.repeated.max_items: 10\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Script Status Strings","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":128},"x-displayname":"Script Status Strings","x-ves-example":"['Action Needed', 'No Action Needed', 'No Action Needed - Resolved']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"128","ves.io.schema.rules.repeated.max_items":"10","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"client_side_defenseSort":{"type":"object","description":"API query sort criteria","title":"Sort","x-displayname":"Sort","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Sort","properties":{"field":{"type":"string","description":"\n\nExample: ` \"field-key\"`","title":"Sort field","x-displayname":"field","x-ves-example":"field-key"},"order":{"$ref":"#/components/schemas/schemaSortOrder"}}},"client_side_defenseSummary":{"type":"object","description":"Summary of the dashboard","title":"Summary","x-displayname":"Summary","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Summary","properties":{"domain":{"type":"string","description":" Name of the domain\n\nExample: ` \"marvel.com\"`","title":"domain","x-displayname":"Domain","x-ves-example":"marvel.com"},"first_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n First seen time\n\nExample: ` \"1650603600000\"`","title":"first_seen","x-displayname":"First Seen","x-ves-example":"1650603600000"},"last_seen":{"type":"string","description":" format: unix epoch timestamp in milliseconds\n Last seen time\n\nExample: ` \"1650603600000\"`","title":"last_seen","x-displayname":"Last Seen","x-ves-example":"1650603600000"},"risk_level":{"type":"string","description":" Risk level of the script\n\nExample: ` \"High Risk\"`","title":"risk_level","x-displayname":"Risk Level","x-ves-example":"High Risk"},"type":{"type":"string","description":" Type of the script\n\nExample: ` \"First Party\"`","title":"type","x-displayname":"Type","x-ves-example":"First Party"}}},"client_side_defenseTestJSRequest":{"type":"object","description":"Request to get injected JS tag status","title":"TestJSRequest","x-displayname":"TestJS Request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.TestJSRequest","properties":{"domain":{"type":"string","description":" Root domain that page URL belongs to\n Example: if you are adding Client-Side Defense JS on checkout.example.com,\n you should enter example.com here.\n\nExample: ` \"company.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.etld_plus_one: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"Domain","maxLength":256,"x-displayname":"Domain","x-ves-example":"company.com","x-ves-validation-rules":{"ves.io.schema.rules.string.etld_plus_one":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"pageURL":{"type":"string","description":" Page URL that user injects JS tag to\n\nExample: ` \"https://www.company.com/login.html\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Page URL","x-displayname":"Page URL","x-ves-example":"https://www.company.com/login.html","x-ves-validation-rules":{"ves.io.schema.rules.string.uri_ref":"true"}}}},"client_side_defenseTestJSResponse":{"type":"object","description":"Get the page url JS status","title":"TestJSResponse","x-displayname":"Test JS Response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.TestJSResponse","properties":{"message":{"type":"string","description":" The error string if the status is failed\n\nExample: ` \"Root domain mistached\"`","title":"message","x-displayname":"Message","x-ves-example":"Root domain mistached"},"status":{"$ref":"#/components/schemas/client_side_defenseTestJSStatusType"}}},"client_side_defenseTestJSStatusType":{"type":"string","description":"Test JS status\n\nThe page URL has been tested and the script tag has been injected\nThe page URL has been tested and the script tag is not found in the page head section\nThere is error when trying to get the page via the given URL","title":"TestJSStatusType","enum":["DETECTED","NOT_DETECTED","FAILED"],"default":"DETECTED","x-displayname":"Test JS Status Type","x-ves-proto-enum":"ves.io.schema.shape.client_side_defense.TestJSStatusType"},"client_side_defenseUpdateDomainsRequest":{"type":"object","description":"Request to update domain","title":"UpdateDomainsRequest","x-displayname":"Update domain request","x-ves-oneof-field-allowed_or_mitigated_domains":"[\"add_to_allowed_domains\",\"add_to_mitigated_domains\"]","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateDomainsRequest","properties":{"add_to_allowed_domains":{"$ref":"#/components/schemas/client_side_defenseAddToAllowedDomains"},"add_to_mitigated_domains":{"$ref":"#/components/schemas/client_side_defenseAddToMitigatedDomains"},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"}}},"client_side_defenseUpdateDomainsResponse":{"type":"object","description":"Response to update domain","title":"UpdateDomainsResponse","x-displayname":"Update domain response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateDomainsResponse"},"client_side_defenseUpdateFieldAnalysisRequest":{"type":"object","description":"Request to patch analysis of fields across scripts","title":"UpdateFieldAnalysisRequest","x-displayname":"Update Field Analysis request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateFieldAnalysisRequest","properties":{"name":{"type":"string","description":" Name\n\nExample: ` \"Username\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"name","x-displayname":"Form Field Name","x-ves-example":"Username","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"type":{"$ref":"#/components/schemas/client_side_defenseANALYSIS_TYPE"}}},"client_side_defenseUpdateFieldAnalysisResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateFieldAnalysisResponse","properties":{"status":{"type":"string","description":" values: not_modified , success\n Status about field analysis status modification\n\nExample: ` \"not_modified\"`","title":"status","x-displayname":"Status","x-ves-example":"not_modified"}}},"client_side_defenseUpdateScriptJustificationRequest":{"type":"object","description":"Request to update script justification","title":"UpdateScriptJustificationRequest","x-displayname":"Update script justification request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateScriptJustificationRequest","properties":{"justification":{"type":"string","description":" Script Justification\n\nExample: ` \"Blocking script due to network callout to malicious domain.\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"justification","x-displayname":"Script Justification","x-ves-example":"Blocking script due to network callout to malicious domain.","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"script_id":{"type":"string","description":" Id of the script\n\nExample: ` \"s-1234567\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"script_id","x-displayname":"Script Id","x-ves-example":"s-1234567","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"user_id":{"type":"string","description":" Id of the justification creator\n\nExample: ` \"u-1234567\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"user_id","x-displayname":"User Id","x-ves-example":"u-1234567","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"client_side_defenseUpdateScriptJustificationResponse":{"type":"object","description":"Response to update script justification","title":"UpdateScriptJustificationResponse","x-displayname":"Update script justification response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateScriptJustificationResponse","properties":{"justification_id":{"type":"string","description":" Id of the justification\n\nExample: ` \"j-1234567\"`","title":"justification_id","x-displayname":"Justification Id","x-ves-example":"j-1234567"}}},"client_side_defenseUpdateScriptReadStatusRequest":{"type":"object","description":"Request to update","title":"UpdateScriptReadStatusRequest","x-displayname":"Update Script FormFields ReadStatus request","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateScriptReadStatusRequest","properties":{"id":{"type":"string","description":" Script id\n\nExample: ` \"s-1234567\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.not_empty: true\n","title":"id","x-displayname":"Script ID","x-ves-example":"s-1234567","x-ves-validation-rules":{"ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"default"},"type":{"$ref":"#/components/schemas/client_side_defenseACTION_TYPE"}}},"client_side_defenseUpdateScriptReadStatusResponse":{"type":"object","description":"Payload about status of script read status result","title":"UpdateScriptReadStatusResponse","x-displayname":"Update script read status response","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdateScriptReadStatusResponse","properties":{"id":{"type":"string","description":" Id of the script\n\nExample: ` \"s-1234567\"`","title":"id","x-displayname":"Script Id","x-ves-example":"s-1234567"},"script_name":{"type":"string","description":" script detected in the webpage\n\nExample: ` \"https://www.google-analytics.com/analytics.js\"`","title":"script_name","x-displayname":"Script Name","x-ves-example":"https://www.google-analytics.com/analytics.js"},"status":{"type":"string","description":" values: not_modified , success\n Status about script read status modification\n\nExample: ` \"not_modified\"`","title":"status","x-displayname":"Status","x-ves-example":"not_modified"}}},"client_side_defenseUpdatedCount":{"type":"object","description":"Pair of count and last updated timestamp, used to provided aggregated domain details","title":"UpdatedCount","x-displayname":"Updated Count","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.UpdatedCount","properties":{"count":{"type":"integer","description":" Aggregated count\n\nExample: ` \"10\"`","title":"Count","format":"int32","x-displayname":"Count","x-ves-example":"10"},"lastUpdated":{"type":"string","description":" Timestamp showing when the count was last update\n\nExample: ` 1629839825497`","title":"LastUpdated","format":"int64","x-displayname":"Last Updated"}}},"schemaSortOrder":{"type":"string","description":"Sort algorithm\n\nSort in descending order\nSort in ascending order","title":"SortOrder","enum":["DESCENDING","ASCENDING"],"default":"DESCENDING","x-displayname":"Sort Order","x-ves-proto-enum":"ves.io.schema.SortOrder"},"shapeclient_side_defenseLocation":{"type":"object","description":"Location scripts pair","title":"Location","x-displayname":"Location","x-ves-proto-message":"ves.io.schema.shape.client_side_defense.Location","properties":{"associatedScripts":{"type":"array","description":" Scripts found at the location\n\nExample: ` \"['www.some-path.com/example/some-js.js','www.some-other-path.com/example/some-other-js.js']\"`","title":"AssociatedScripts","items":{"type":"string"},"x-displayname":"Associated scripts","x-ves-example":"['www.some-path.com/example/some-js.js','www.some-other-path.com/example/some-other-js.js']"},"location":{"type":"string","description":" Location of the scripts\n\nExample: ` \"www.some.domain.com/resetPassword\"`","title":"Location","x-displayname":"Location","x-ves-example":"www.some.domain.com/resetPassword"}}}}}}