Get All Decryption Policy - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Decryption Policy","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the list of all decryption policies.**","operationId":"getAllDecryptionPolicy","parameters":[{"description":"Filter by name of the decryption policy.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies?limit=2 ( Get all decryption policies with limit set to 2 )":{"value":{"items":[{"id":"969ef100-c656-11ec-a35d-30484f453c53","name":"test_policy_42_modified","type":"DecryptionPolicy"},{"id":"ff9bc964-c5e6-11ec-9e05-a1814f453c53","name":"test_policy_47","type":"DecryptionPolicy"}],"links":{"self":"https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=0&limit=2"},"paging":{"count":6,"limit":2,"next":["https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=2&limit=2","https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=4&limit=2"],"offset":0,"pages":3}}},"Example 2 : GET /fmc_config/v1/domain/domainUUID/policy/decryptionpolicies?limit=2&expanded=true ( Get all decryption policies with limit set to 2 and expanded set to true )":{"value":{"items":[{"advancedOptions":{"adaptiveProbe":true,"blockExtensions":[65846],"disallowUntrustedIssuerResign":false,"quicDecryption":false,"stripHTTP3":true,"tls13Decryption":true},"defaultAction":{"eventLogAction":"LOG_FLOW_END","policyAction":"BLOCK"},"description":"test_description_modified","id":"969ef100-c656-11ec-a35d-30484f453c53","links":{"self":"https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/969ef100-c656-11ec-a35d-30484f453c53"},"logging":{"logEnd":true,"sendEvents":true},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"timestamp":1651095681},"name":"test_policy_42_modified","trustedCAs":{"objects":[{"id":"5f8dd758-ac46-36ff-bd83-48c6987228e7","name":"Amazon-Root-CA-1","type":"ExternalCACertificate"},{"id":"d3856136-b65c-49e6-ac4c-0daf5be98bc1","name":"Cisco-Trusted-Authorities","type":"ExternalCACertificateGroup"}]},"type":"DecryptionPolicy","undecryptableActions":{"compressedSession":"INHERIT_DEFAULT_ACTION","decryptionErrors":"BLOCK","handshakeErrors":"INHERIT_DEFAULT_ACTION","sessionNotCached":"INHERIT_DEFAULT_ACTION","sslV2Session":"DO_NOT_DECRYPT","unknownCipherSuite":"INHERIT_DEFAULT_ACTION","unsupportedCipherSuite":"INHERIT_DEFAULT_ACTION"}},{"advancedOptions":{"adaptiveProbe":true,"blockExtensions":[],"disallowUntrustedIssuerResign":true,"quicDecryption":false,"stripHTTP3":false,"tls13Decryption":false},"defaultAction":{"eventLogAction":"LOG_NONE","policyAction":"DO_NOT_DECRYPT"},"id":"ff9bc964-c5e6-11ec-9e05-a1814f453c53","links":{"self":"https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies/ff9bc964-c5e6-11ec-9e05-a1814f453c53"},"logging":{"logEnd":false,"sendEvents":false},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"lastUser":{"name":"admin"},"timestamp":1651035649},"name":"test_policy_47","trustedCAs":{"objects":[{"id":"d3856136-b65c-49e6-ac4c-0daf5be98bc1","name":"Cisco-Trusted-Authorities","type":"ExternalCACertificateGroup"}]},"type":"DecryptionPolicy","undecryptableActions":{"compressedSession":"INHERIT_DEFAULT_ACTION","decryptionErrors":"BLOCK","handshakeErrors":"INHERIT_DEFAULT_ACTION","sessionNotCached":"INHERIT_DEFAULT_ACTION","sslV2Session":"INHERIT_DEFAULT_ACTION","unknownCipherSuite":"INHERIT_DEFAULT_ACTION","unsupportedCipherSuite":"INHERIT_DEFAULT_ACTION"}}],"links":{"self":"https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=0&limit=2&expanded=true"},"paging":{"count":6,"limit":2,"next":["https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=2&limit=2&expanded=true","https://u90c04p03-vrouter.cisco.com:22228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/decryptionpolicies?offset=4&limit=2&expanded=true"],"offset":0,"pages":3}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Represents the Decryption Policy used to determine how to handle encrypted traffic.","properties":{"advancedOptions":{"description":"List of advanced options that can be configured for the Decryption policy.","type":"object","properties":{"adaptiveProbe":{"type":"boolean"},"blockExtensions":{"items":{"format":"int32","type":"integer"},"type":"array"},"disallowUntrustedIssuerResign":{"type":"boolean"},"quicDecryption":{"type":"boolean"},"stripHTTP3":{"type":"boolean"},"tls13Decryption":{"type":"boolean"}},"$$ref":"#/components/schemas/DecryptionPolicyAdvancedOptions"},"defaultAction":{"description":"Default action object which contains the action to take when no rule matches.","type":"object","properties":{"eventLogAction":{"enum":["LOG_FLOW_END","LOG_NONE"],"type":"string"},"policyAction":{"enum":["DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"}},"$$ref":"#/components/schemas/DecryptionPolicyDefaultAction"},"description":{"description":"Description of the policy.","type":"string"},"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"},"logging":{"description":"Logging configuration for the policy.","type":"object","properties":{"logEnd":{"type":"boolean"},"sendEvents":{"type":"boolean"}},"$$ref":"#/components/schemas/DecryptionPolicyLogging"},"metadata":{"description":"An object representing the metadata of the policy.","type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","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":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","description":"This object defines details about the user.","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing 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":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"lockedByUser":{"type":"string"},"lockingActivity":{"type":"string"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/DecryptionPolicyMetadata"},"name":{"description":"User chosen resource name.","type":"string"},"trustedCAs":{"description":"Trusted CAs which are being used by the Decryption Policy.","type":"object","properties":{"objects":{"items":{"type":"object","properties":{"description":{"type":"string"},"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"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/IExternalCACertificateBase"},"type":"array"}},"$$ref":"#/components/schemas/TrustedCAs"},"type":{"description":"Type of the response object. This value is always 'DecryptionPolicy'.","type":"string"},"undecryptableActions":{"description":"Actions which need to be taken for undecryptable traffic in different conditions.","type":"object","properties":{"compressedSession":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"},"decryptionErrors":{"enum":["BLOCK","BLOCK_WITH_RESET"],"type":"string"},"handshakeErrors":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"},"sessionNotCached":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"},"sslV2Session":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"},"unknownCipherSuite":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"},"unsupportedCipherSuite":{"enum":["INHERIT_DEFAULT_ACTION","DO_NOT_DECRYPT","BLOCK","BLOCK_WITH_RESET"],"type":"string"}},"$$ref":"#/components/schemas/DecryptionPolicyUndecryptableActions"}},"$$ref":"#/components/schemas/DecryptionPolicy"},"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"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/DecryptionPolicyListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"getAllDecryptionPolicy","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/decryptionpolicies"}}