AccessRulePage - Security Cloud Control Firewall Manager API Documentation

{"type":"model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"properties":{"accessGroupUid":{"description":"The unique identifier, represented as a UUID, of the Access Group associated with the Access Rule.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"createdDate":{"description":"The time (in UTC) at which Access Rule was created, represented using the RFC-3339 standard.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"},"destinationDynamicObject":{"description":"The destination dynamic object.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"destinationNetwork":{"description":"The destination network.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"destinationPort":{"description":"The destination port.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"entityUid":{"description":"The unique identifier, represented as a UUID, of the device/manager associated with the Access Rule. Points to shared Access Group in case of shared Rule","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"index":{"description":"Access rule index position in Access Group ordered rule list.","example":1,"format":"int32","type":"integer"},"isActiveRule":{"description":"Indicates whether this rule is active.","type":"boolean"},"issues":{"description":"Indicates if rule has SHADOWED, SHARED or DUPLICATE (remark) issue.","items":{"description":"Represents an access rule issue, including issue type and causes.","properties":{"causes":{"description":"A list of the causes for the rule being marked with an issue.","example":[{"causeTypes":["SHADOWED_BY_NETWORK_ADDRESS","SHADOWED_BY_ICMP"],"causingRule":"Rule_1","causingRuleIdx":5}],"items":{"description":"Represents a specific cause for an access rule issue.","properties":{"causeTypes":{"description":"A set of cause types for the issue.","example":["SHADOWED_BY_NETWORK_ADDRESS","SHADOWED_BY_ICMP","DUPLICATE_REMARK"],"items":{"enum":["SHADOWED_BY_NETWORK_ADDRESS","SHADOWED_BY_PORT","SHADOWED_BY_ICMP","SHADOWED_BY_ACTION","DUPLICATE_REMARK","UNKNOWN"],"type":"string"},"type":"array","uniqueItems":true},"causingRule":{"description":"The rule that is causing the issue.","type":"string"},"causingRuleIdx":{"description":"The index of the causing rule.","format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/Cause"},"type":"array"},"issueType":{"description":"Indicates if the rule has any known issue. For unknown issues, UNKNOWN value will be used.","enum":["SHADOWED","SHARED","DUPLICATE","UNKNOWN"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/AccessRuleIssue"},"type":"array","uniqueItems":true},"logSettings":{"description":"The set of of interface and direction pairs or global resource.","properties":{"interval":{"description":"The interval","example":1,"format":"int32","type":"integer"},"level":{"description":"The level","example":3,"type":"string"}},"type":"object","$$ref":"#/components/schemas/LogSettings"},"protocol":{"description":"The protocol.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"remark":{"description":"A remark.","type":"string"},"ruleAction":{"description":"Representation of the rule action.","enum":["PERMIT","DENY"],"type":"string"},"ruleConfigurationLineNumber":{"description":"Representation of the rule's line number in configuration.","example":1021,"format":"int64","type":"integer"},"ruleConfigurationText":{"description":"Representation of the rule in configuration.","example":"access-list ExampleList extended permit ip any any","type":"string"},"ruleParsingError":{"description":"The error, if any, that was encountered when parsing the rule.","example":"Could not parse [255.0.0.255]","type":"string"},"ruleTimeRange":{"description":"The rule time range.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"ruleType":{"description":"The L3 level rule type. L3, L7 or CONTENT_FILTERING. Defaults to L3.","example":"L3","type":"string"},"sharedAccessGroupUid":{"description":"Optional unique identifier for the shared Access Group associated with a shared Access Rule.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"sourceDynamicObject":{"description":"The source dynamic object.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"sourceNetwork":{"description":"The source network.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"sourcePort":{"description":"The source port.","properties":{"elements":{"description":"The list of elements.","items":{"type":"string"},"type":"array"},"name":{"description":"The name","example":"any","type":"string"},"type":{"description":"The type of the policy object.","enum":["NETWORK_OBJECT","IPV4_ADDRESS_POOL","IPV6_ADDRESS_POOL","NETWORK_GROUP","SERVICE_OBJECT","SERVICE_TCP_OBJECT","SERVICE_UDP_OBJECT","SERVICE_ICMPV4_OBJECT","SERVICE_ICMPV6_OBJECT","SERVICE_PROTOCOL_OBJECT","SERVICE_GROUP","SERVICE_FTD_GROUP","PROTOCOL_GROUP","ICMP_GROUP","URL_OBJECT","URL_GROUP","APPLICATION_FILTER_OBJECT","TIME_RANGE"],"example":"NETWORK_OBJECT","type":"string"},"uid":{"description":"The unique identifier.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"required":["name"],"type":"object","$$ref":"#/components/schemas/AccessRuleDetailsContent"},"uid":{"description":"The unique identifier, represented as a UUID, of Access Rule in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"updatedDate":{"description":"The time (in UTC) at which Access Rule was updated, represented using the RFC-3339 standard.","example":"2023-12-13T05:15:44Z","format":"date-time","type":"string"}},"required":["accessGroupUid","entityUid","index","uid"],"type":"object","$$ref":"#/components/schemas/AccessRule"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/AccessRulePage","title":"AccessRulePage"}}