AccessRuleCreateInput - 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":{"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"},"activeRule":{"type":"boolean"},"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/DestinationDynamicObjectContent"},"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/DestinationNetworkContent"},"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/DestinationPortContent"},"entityUid":{"description":"The unique identifier, represented as a UUID, of the device/manager associated with the Access Rule. Points to the shared Access Group in the case of a shared Access Rule being created.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"index":{"description":"The position of the Access Rule in the orded list of rules in an Access Group.","example":1,"format":"int32","type":"integer"},"logSettings":{"description":"The level and interval of the log.","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. Defaults to IP.","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/ProtocolContent"},"remark":{"description":"A human-readable remark. This is typically used to describe the intentions of the access rule.","type":"string"},"ruleAction":{"description":"The rule's action.","enum":["PERMIT","DENY"],"example":"PERMIT","type":"string"},"ruleTimeRange":{"description":"The optional time range for which the access rule is active.","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/RuleTimeRangeContent"},"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/SourceDynamicObjectContent"},"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/SourceNetworkContent"},"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/SourcePortContent"}},"required":["accessGroupUid","entityUid","index"],"type":"object","$$ref":"#/components/schemas/AccessRuleCreateInput","title":"AccessRuleCreateInput"}}