Create External CA Certificate - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create External CA 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":"**Create a trusted Certificate Authority. _Check the response section for applicable examples (if any)._**","operationId":"createExternalCACertificate","parameters":[{"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"}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcacertificates ( Test trusted CA import with certificate )":{"value":{"cert":"-----BEGIN CERTIFICATE-----\nMIIEHzCCAwegAwIBAgIUXTjDPsnWV+ig5NI0sDORuSY7wvYwDQYJKoZIhvcNAQEL\nBQAwgZ4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOVjESMBAGA1UEBwwJTGFzIFZl\nZ2FzMRowGAYDVQQKDBFDaGFzZSBDb3Jwb3JhdGlvbjEcMBoGA1UECwwTZWNvbW1l\ncmNlICwgZmluYW5jZTEWMBQGA1UEAwwNd3d3LmNoYXNlLmNvbTEcMBoGCSqGSIb3\nDQEJARYNYWJjQGNoYXNlLmNvbTAeFw0xOTEyMTIyMjI5MTNaFw0yOTEyMDkyMjI5\nMTNaMIGeMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlYxEjAQBgNVBAcMCUxhcyBW\nZWdhczEaMBgGA1UECgwRQ2hhc2UgQ29ycG9yYXRpb24xHDAaBgNVBAsME2Vjb21t\nZXJjZSAsIGZpbmFuY2UxFjAUBgNVBAMMDXd3dy5jaGFzZS5jb20xHDAaBgkqhkiG\n9w0BCQEWDWFiY0BjaGFzZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQCbMjm0qobAvVY4zxBEmqH5eADF+cdqFhr8iNW4B3EvR9M2A+WiHP/OY7if\n6jn1c/c5T4uIbyELZ2Q/ESKd0z3NH5gPpilkLWxaaC+wkzWSfGctJy2UoddlDp0q\nOfUwzPJP4hOKqaYChOH7wdcJCaykZ49lgbLDtJT9XsaeCIfb9AIk+Ujki8IjEfHj\n84Fkk0wrlM58+ZdD6vZ+cNTuUaZy8SLnv6IiX9ML1pe4HPiB4a2R0bYYD7HBxIJu\nQFqC2cBoKTITzRqJfz/xF7MGEmN+IGknj7uBDkCtY2/2+w0bBuIMExwO0CURVyR0\ne9zLF+Ik0RUxFRUOjwvd5OA7bxujAgMBAAGjUzBRMB0GA1UdDgQWBBRqNcb0pcx7\nu15+wGA4qgMlNUxfJTAfBgNVHSMEGDAWgBRqNcb0pcx7u15+wGA4qgMlNUxfJTAP\nBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA0jBnsMAT8/X9UHO1y\n+C6UNjtcOELiH3a5H+5WhYQ3jHEry2o//jDmFUI1/Sd9ZDTW8g+bU0vSz/PnAA8J\ndyqzPJxfQUXrcuKrcX/msJbB3FRXkUlEKDSkDCo3gA5VuVLVTFdEm716lH9dERUx\n5mBFTAsX18hnyD2e80e9DGnPhLvHJ7zps7WHsgBkWMhw3wJmZ7OvmCDSYqzeteSc\n1X7P4mUCPJWLnUu1gax0rjWwLujaZ4b2ir/1ad1KfwYyoiUoA7bw2qTWbn5ljzFs\nqD8QPtmp3108A2owIMO+TvVnjkP5wbFeND9ATuDghvm/uA49DA5pb68nyVQRHfpn\nTsFC\n-----END CERTIFICATE-----","name":"trusted_ca_1"}}},"schema":{"type":"object","description":"Represents the CA public key certificate object belonging to a trusted CA.","properties":{"cert":{"description":"PEM, DER, or PKCS#7 formatted certificate contents.","type":"string"},"certFingerprint":{"description":"Unique sequence used to identify the certificate.","type":"string"},"crlSerials":{"description":"Serial numbers in hex format of certificates in the certificate revocation list.","items":{"type":"string"},"type":"array"},"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 'InternalCertificate'.","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/ExternalCACertificate"}}},"description":"Input representation of Trusted CA object.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/domainUUID/object/externalcacertificates ( Test trusted CA import with certificate )":{"value":{"cert":"-----BEGIN CERTIFICATE-----\nMIIEHzCCAwegAwIBAgIUXTjDPsnWV+ig5NI0sDORuSY7wvYwDQYJKoZIhvcNAQEL\nBQAwgZ4xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOVjESMBAGA1UEBwwJTGFzIFZl\nZ2FzMRowGAYDVQQKDBFDaGFzZSBDb3Jwb3JhdGlvbjEcMBoGA1UECwwTZWNvbW1l\ncmNlICwgZmluYW5jZTEWMBQGA1UEAwwNd3d3LmNoYXNlLmNvbTEcMBoGCSqGSIb3\nDQEJARYNYWJjQGNoYXNlLmNvbTAeFw0xOTEyMTIyMjI5MTNaFw0yOTEyMDkyMjI5\nMTNaMIGeMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlYxEjAQBgNVBAcMCUxhcyBW\nZWdhczEaMBgGA1UECgwRQ2hhc2UgQ29ycG9yYXRpb24xHDAaBgNVBAsME2Vjb21t\nZXJjZSAsIGZpbmFuY2UxFjAUBgNVBAMMDXd3dy5jaGFzZS5jb20xHDAaBgkqhkiG\n9w0BCQEWDWFiY0BjaGFzZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\nAoIBAQCbMjm0qobAvVY4zxBEmqH5eADF+cdqFhr8iNW4B3EvR9M2A+WiHP/OY7if\n6jn1c/c5T4uIbyELZ2Q/ESKd0z3NH5gPpilkLWxaaC+wkzWSfGctJy2UoddlDp0q\nOfUwzPJP4hOKqaYChOH7wdcJCaykZ49lgbLDtJT9XsaeCIfb9AIk+Ujki8IjEfHj\n84Fkk0wrlM58+ZdD6vZ+cNTuUaZy8SLnv6IiX9ML1pe4HPiB4a2R0bYYD7HBxIJu\nQFqC2cBoKTITzRqJfz/xF7MGEmN+IGknj7uBDkCtY2/2+w0bBuIMExwO0CURVyR0\ne9zLF+Ik0RUxFRUOjwvd5OA7bxujAgMBAAGjUzBRMB0GA1UdDgQWBBRqNcb0pcx7\nu15+wGA4qgMlNUxfJTAfBgNVHSMEGDAWgBRqNcb0pcx7u15+wGA4qgMlNUxfJTAP\nBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA0jBnsMAT8/X9UHO1y\n+C6UNjtcOELiH3a5H+5WhYQ3jHEry2o//jDmFUI1/Sd9ZDTW8g+bU0vSz/PnAA8J\ndyqzPJxfQUXrcuKrcX/msJbB3FRXkUlEKDSkDCo3gA5VuVLVTFdEm716lH9dERUx\n5mBFTAsX18hnyD2e80e9DGnPhLvHJ7zps7WHsgBkWMhw3wJmZ7OvmCDSYqzeteSc\n1X7P4mUCPJWLnUu1gax0rjWwLujaZ4b2ir/1ad1KfwYyoiUoA7bw2qTWbn5ljzFs\nqD8QPtmp3108A2owIMO+TvVnjkP5wbFeND9ATuDghvm/uA49DA5pb68nyVQRHfpn\nTsFC\n-----END CERTIFICATE-----","certFingerprint":"D5:2E:64:1B:95:77:65:E6:F2:7D:09:D4:C5:ED:3F:98:99:4B:12:81","crlSerials":[],"id":"c8056876-ff0b-11ec-b1fe-6d1f4677d29c","issuerCommonName":"www.chase.com","issuerOrganization":"Chase Corporation","issuerOrganizationUnit":"ecommerce","name":"trusted_ca_1","publicKeyFingerprint":"dbc7f674230336d43ca0e64fad3a4f46bb8c28c4","serialNumber":"5d:38:c3:3e:c9:d6:57:e8:a0:e4:d2:34:b0:33:91:b9:26:3b:c2:f6","subjectCommonName":"www.chase.com","subjectOrganization":"Chase Corporation","subjectOrganizationUnit":"ecommerce","type":"ExternalCACertificate","validityEndDate":"Dec 9 22:29:13 2029 GMT","validityStartDate":"Dec 12 22:29:13 2019 GMT"}}},"schema":{"type":"object","description":"Represents the CA public key certificate object belonging to a trusted CA.","properties":{"cert":{"description":"PEM, DER, or PKCS#7 formatted certificate contents.","type":"string"},"certFingerprint":{"description":"Unique sequence used to identify the certificate.","type":"string"},"crlSerials":{"description":"Serial numbers in hex format of certificates in the certificate revocation list.","items":{"type":"string"},"type":"array"},"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 'InternalCertificate'.","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/ExternalCACertificate"}}},"description":"Created"},"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":"createExternalCACertificate","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/externalcacertificates"}}