ZeroTrustPolicy - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"properties":{"acsUrl":{"type":"string"},"description":{"type":"string"},"entry":{"type":"object","properties":{"applicationList":{"items":{"type":"object","properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"authenticationTimeout":{"format":"int32","type":"integer"},"description":{"type":"string"},"enabled":{"type":"boolean"},"externalURL":{"type":"string"},"filePolicy":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"forceReauthentication":{"type":"boolean"},"group":{"type":"boolean"},"groupId":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"id":{"format":"int32","type":"integer"},"idpCertificate":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"idpEntityId":{"type":"string"},"idpSsoUrl":{"type":"string"},"interfaceList":{"items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"type":"array"},"internalURL":{"type":"string"},"l2SwitchingEnabled":{"type":"boolean"},"literal":{"type":"boolean"},"mandatory":{"type":"boolean"},"mappedPort":{"format":"int32","type":"integer"},"metadataAppCount":{"format":"int32","type":"integer"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"readOnly":{"type":"boolean"},"samlAcsUrl":{"type":"string"},"samlEntityId":{"type":"string"},"snort3IntrusionPolicy":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"sourceNAT":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"sourceNATIPv6":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"sslCertificate":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"subType":{"type":"string"},"tooltip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"variableSet":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"ztnaConfigInheritanceSettings":{"type":"object","properties":{"filePolicy":{"enum":["INHERIT","OVERRIDE"],"type":"string"},"intrusionPolicy":{"enum":["INHERIT","OVERRIDE"],"type":"string"},"securityZones":{"enum":["INHERIT","OVERRIDE"],"type":"string"}},"$$ref":"#/components/schemas/ZTNAConfigInheritanceSettings"},"ztnaPolicyId":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/ZTNAApplicationEntry"},"type":"array"},"assignmentStatus":{"type":"object","properties":{"applyingDeviceCount":{"format":"int32","type":"integer"},"assignedDeviceCount":{"format":"int32","type":"integer"},"assignedTemplateCount":{"format":"int32","type":"integer"},"enforcedDomainForSubDomain":{"type":"string"},"enforcedDomainsList":{"items":{"type":"string"},"type":"array"},"uptoDateDeviceCount":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PolicyGroupStatus"},"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"defaultPgEditable":{"type":"boolean"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"lastModifiedTime":{"format":"int32","type":"integer"},"lastModifyingUserName":{"type":"string"},"literal":{"type":"boolean"},"name":{"type":"string"},"policySettings":{"type":"object","properties":{"acsBaseUrl":{"type":"string"},"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"certificate":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"description":{"type":"string"},"enabled":{"type":"boolean"},"filePolicy":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"globalPortPool":{"type":"string"},"id":{"format":"int32","type":"integer"},"interfaceList":{"items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"type":"array"},"l2SwitchingEnabled":{"type":"boolean"},"literal":{"type":"boolean"},"logEnabled":{"type":"boolean"},"mandatory":{"type":"boolean"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"readOnly":{"type":"boolean"},"snort3IntrusionPolicy":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"subType":{"type":"string"},"tooltip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"variableSet":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"}},"$$ref":"#/components/schemas/ZTNAPolicyEntry"},"readOnly":{"type":"boolean"},"status":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ZTNAPolicyGroupEntry"},"filePolicy":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"globalPortPool":{"type":"string"},"id":{"type":"string"},"intrusionPolicy":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"logEnabled":{"type":"boolean"},"metadata":{"type":"object","properties":{"dirtyDeviceCount":{"format":"int32","type":"integer"},"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"},"totalDeviceCount":{"format":"int32","type":"integer"},"totalTemplateCount":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IPolicyGroupMetadata"},"name":{"type":"string"},"proxyCertificate":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"securityZones":{"items":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"type":"array"},"type":{"type":"string"},"variableSet":{"type":"object","description":"Contains reference information.","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"version":{"type":"string"}},"type":"object","title":"ZeroTrustPolicy"}}