Get External Certificate - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get External Certificate","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 external certificates.**","operationId":"getExternalCertificate","parameters":[{"description":"Filter by name of the certificate.","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/object/externalcertificates?limit=2 ( Get all external certificates with limit set to 2 )":{"value":{"items":[{"id":"3ec5aea6-0dff-11ed-8f01-77c97872e20b","name":"abc","type":"ExternalCertificate"},{"id":"dca27b98-0dfc-11ed-a640-82917872e20b","name":"external_cert_2","type":"ExternalCertificate"}],"links":{"self":"https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=0&limit=2"},"paging":{"count":3,"limit":2,"next":["https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=2&limit=1"],"offset":0,"pages":2}}},"Example 2 : GET /fmc_config/v1/domain/domainUUID/object/externalcertificates?limit=2&expanded=true ( Get all internal certificates with limit set to 2 and expanded set to true )":{"value":{"items":[{"cert":"-----BEGIN CERTIFICATE-----\nMIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV\nBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE\nChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy\nNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3\nMTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp\ndHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs\nMTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG\nSIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg\nx9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6\nimwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt\n8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC\nsDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46\noYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0\ndHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx\nMDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT\nFzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3\nhGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko\n42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu\nrIuPFw==\n-----END CERTIFICATE-----\n","certFingerprint":"50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3","id":"43f07e84-0d18-11ed-aefa-fbeb515ffda9","issuerCommonName":"internal1024.internal1024","issuerOrganization":"Sourcefire","issuerOrganizationUnit":"Development","name":"external_cert_1","publicKeyFingerprint":"820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521","serialNumber":"fa:a5:5d:ae:66:34:13:17","subjectCommonName":"internal1024.internal1024","subjectOrganization":"Sourcefire","subjectOrganizationUnit":"Development","type":"ExternalCertificate","validityEndDate":"2025-03-07T15:45:51Z","validityStartDate":"2015-03-10T15:45:51Z"},{"cert":"-----BEGIN CERTIFICATE-----\nMIIDYDCCAsmgAwIBAgIJAPqlXa5mNBMXMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNV\nBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0dHNidXJnaDETMBEGA1UE\nChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwxMDI0LmludGVybmFsMTAy\nNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnQwHhcNMTUwMzEwMTU0NTUxWhcNMjUwMzA3\nMTU0NTUxWjB+MQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExEzARBgNVBAcTClBp\ndHRzYnVyZ2gxEzARBgNVBAoTClNvdXJjZWZpcmUxIjAgBgNVBAMTGWludGVybmFs\nMTAyNC5pbnRlcm5hbDEwMjQxFDASBgNVBAsTC0RldmVsb3BtZW50MIGfMA0GCSqG\nSIb3DQEBAQUAA4GNADCBiQKBgQCivQIImKK+11/BUxESTfgy/F1bYkM+NapK8jOg\nx9DF1y+5wDBqaoFpNzCCEgC3I/NfehI+KbuJFwgO7i4+IGqRkDZtNxmQ8SsEwEQ6\nimwl+brHNFcXLrw/Ih5OW9JuSgU1Zc2bx2O7CAFLMuuJxFtyFImFwf+X2f8namOt\n8FPKFQIDAQABo4HlMIHiMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFO6c6Fbf5jtC\nsDJ4RsCip+KcZM46MIGyBgNVHSMEgaowgaeAFO6c6Fbf5jtCsDJ4RsCip+KcZM46\noYGDpIGAMH4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJQQTETMBEGA1UEBxMKUGl0\ndHNidXJnaDETMBEGA1UEChMKU291cmNlZmlyZTEiMCAGA1UEAxMZaW50ZXJuYWwx\nMDI0LmludGVybmFsMTAyNDEUMBIGA1UECxMLRGV2ZWxvcG1lbnSCCQD6pV2uZjQT\nFzANBgkqhkiG9w0BAQUFAAOBgQBL8xwr1cijq0pAS4DlgLF2hT1Q+rP6/qpW6sp3\nhGgtdyk6jC/UofWERS6Y5YYkrEfTLJltXRK6ndBKgwpisBY3krwIFGY0kIyxgEko\n42/r3JM6GJZEfRfurXVazELShfjI8WFolnJawBU6Bvt8opY4BHkdyBChNWcYZsLu\nrIuPFw==\n-----END CERTIFICATE-----\n","certFingerprint":"50:9D:77:44:D4:A3:AC:3B:E1:F6:11:2E:85:19:15:0B:D0:D4:6B:D3","id":"3ec5aea6-0dff-11ed-8f01-77c97872e20b","issuerCommonName":"internal1024.internal1024","issuerOrganization":"Sourcefire","issuerOrganizationUnit":"Development","name":"abc","publicKeyFingerprint":"820bad9cae9c1ef9eb2cfea20ebbfe3fe2eb4521","serialNumber":"fa:a5:5d:ae:66:34:13:17","subjectCommonName":"internal1024.internal1024","subjectOrganization":"Sourcefire","subjectOrganizationUnit":"Development","type":"ExternalCertificate","validityEndDate":"2025-03-07T15:45:51Z","validityStartDate":"2015-03-10T15:45:51Z"}],"links":{"self":"https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=0&limit=2&expanded=true"},"paging":{"count":3,"limit":2,"next":["https://172.29.182.90:10228/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/externalcertificates?offset=2&limit=1&expanded=true"],"offset":0,"pages":2}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Represents a server public key certificate that does not belong to the user's organization.","properties":{"cert":{"description":"PEM, DER, or PKCS#7 formatted certificate contents.","type":"string"},"certFingerprint":{"description":"Unique sequence used to identify the certificate.","type":"string"},"description":{"type":"string"},"id":{"description":"Unique identifier representing resource.","type":"string"},"issuerCommonName":{"description":"Common name of the issuer that signed and issued the certificate.","type":"string"},"issuerOrganization":{"description":"Organization, company name, of the issuer that signed and issued the certificate.","type":"string"},"issuerOrganizationUnit":{"description":"Organization Unit, division or unit, of the issuer that signed and issued the certificate.","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"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","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":{"description":"The last user who modified this instance.","type":"object","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"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","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":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"User chosen resource name.","type":"string"},"publicKeyFingerprint":{"description":"SHA1 hash sequence used to identify the public key.","type":"string"},"serialNumber":{"description":"Unique number assigned by CA to the certificate on generation. The issuer name and serial number identify a unique certificate.","type":"string"},"subjectCommonName":{"description":"Common name of the subject being certified in the given certificate.","type":"string"},"subjectOrganization":{"description":"Organization, company name, of the subject being certified in the given certificate.","type":"string"},"subjectOrganizationUnit":{"description":"The Organization Unit, division or unit, of the subject being certified in the given certificate.","type":"string"},"type":{"description":"Type of the response object. This value is always 'ExternalCertificate'.","type":"string"},"validityEndDate":{"description":"Certificate validity end date in ISO 8601 format.","type":"string"},"validityStartDate":{"description":"Certificate validity start date in ISO 8601 format.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ExternalCertificate"},"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/ExternalCertificateListContainer"}}},"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":["Object"],"__originalOperationId":"getExternalCertificate","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcertificates"}}