Create Manage Device Certificates Request Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Manage Device Certificates Request 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":{"deprecated":false,"description":"**Perform a certificate enrollment operation on devices. Possible action values are \u003ccode\u003eENROLL\u003c/code\u003e, \u003ccode\u003eRE_ENROLL\u003c/code\u003e, \u003ccode\u003eREFRESH\u003c/code\u003e, \u003ccode\u003eDELETE\u003c/code\u003e, and \u003ccode\u003eEXPORT\u003c/code\u003e. All actions require a \u003ccode\u003edeviceCertificates\u003c/code\u003e section containing a deviceID and \u003ccode\u003ecertificates\u003c/code\u003e subsection. \u003ccode\u003eEXPORT\u003c/code\u003e also requires a \u003ccode\u003eexportOptions\u003c/code\u003e subsection containing isPemFormat which can be either true or false and a passPhrase. There can be multiple deviceCertificates sections, but each section may only have one deviceId and one certificate per deviceID. You cannot use multiple actions in the same POST operation.\u003cbr\u003e\u003cbr\u003e\u003ccode\u003eENROLL\u003c/code\u003e pushes a certificate file onto a device.\u003cbr\u003e\u003cbr\u003e\u003ccode\u003eRE_ENROLL\u003c/code\u003e perform an \u003ccode\u003eENROLL\u003c/code\u003e but cleans up any failed previous enrollment.\u003cbr\u003e\u003cbr\u003e\u003ccode\u003eREFRESH\u003c/code\u003e gets the devices current certificate enrollment status.\u003cbr\u003e\u003cbr\u003e\u003ccode\u003eDELETE\u003c/code\u003e deletes a specific certificate enrollment and the certificate information from the device.\u003cbr\u003e\u003cbr\u003e\u003ccode\u003eEXPORT\u003c/code\u003e requests a copy of an existing certificate from the device. _Check the response section for applicable examples (if any)._**","operationId":"createManageDeviceCertificatesRequestModel","parameters":[{"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/devices/operational/managecertificate ( Enroll a certificate on a device )":{"value":{"action":"ENROLL","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}]}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Re-enroll a certificate on a device )":{"value":{"action":"RE_ENROLL","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}]}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Refresh a certificate on a device )":{"value":{"action":"REFRESH","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}]}},"Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Delete a certificate on a device )":{"value":{"action":"DELETE","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}]}},"Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Export a certificate from a device )":{"value":{"action":"EXPORT","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"},"exportOptions":{"isPemFormat":false,"passPhrase":"test"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}]}}},"schema":{"type":"object","properties":{"action":{"enum":["ENROLL","RE_ENROLL","REFRESH","DELETE","EXPORT"],"type":"string"},"description":{"type":"string"},"deviceCertificates":{"items":{"type":"object","properties":{"certificates":{"items":{"type":"object","properties":{"certificate":{"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"},"exportOptions":{"type":"object","properties":{"isPemFormat":{"type":"boolean"},"passPhrase":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceCertificateExportOptions"}},"$$ref":"#/components/schemas/ICertificateDetails"},"type":"array"},"deviceId":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceCertificate"},"type":"array"},"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","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"},"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"},"task":{"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"},"message":{"type":"string"},"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"},"showDetailedDeviceStatus":{"type":"string"},"status":{"type":"string"},"subTasks":{"items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"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"},"status":{"type":"string"},"target":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","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":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"}},"$$ref":"#/components/schemas/ISubTask"},"type":"array"},"taskType":{"enum":["DEVICE_REGISTRATION","SMART_LICENSE","DEVICE_DEPLOYMENT","DEVICE_ROLLBACK","NGFWHA_OPERATIONS","COPY_CONFIG_REQUEST","HIT_COUNT_REFRESH","FTD_CLUSTER_BOOTSTRAP","FTD_CLUSTER_CREATE","FTD_CLUSTER_BREAK","FTD_CLUSTER_ADD_NODES","FTD_CLUSTER_REMOVE_NODES","DEVICE_BACKUP","FTD_CLUSTER_UPDATE_BOOTSTRAP","FTD_CLUSTER_COMMAND","SSP_EPM_OIR","SSP_EPM_BREAKOUT_DEPLOY","DEVICE_EXPORT","DEVICE_IMPORT","POLICY_EXPORT","CHASSIS_REGISTRATION","CHANGE_MANAGER","CONFIGURE_DEVICE_VALIDATE","CONFIGURE_DEVICE","CONFIGURE_MANAGER","CONFIGURE_MANAGER_ADD","CONFIGURE_MANAGER_DELETE","INITIATE_MIGRATION","DISCARD_MIGRATION","SWITCH_TO_ANALYTICS","DELETE_DEVICE","GENERATE_REPORTS","FLEXCONFIG_MIGRATION","DEVICE_UNREGISTRATION","PENDING_CHANGES_REQUEST","DEVICE_TROUBLESHOOT","DEVICE_MODEL_MIGRATION","DEVICE_TEMPLATE_CREATION","CHASSIS_CONVERSION_REQUEST","SNORT_PROFILER","CPU_PROFILER","POLICY_REPORT_GENERATION","DEVICE_TEMPLATE_APPLY","LTP_ONBOARDING","POLICY_CLONE_OPERATION","DEVICE_CERTIFICATE_MANAGEMENT","OOB_CHANGES_REQUEST","UPLOAD_TROUBLESHOOT","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/TaskStatus"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/TaskMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ManageDeviceCertificatesRequestModel"}}},"description":"Specify the action type, the list of devices and the list of certificates to perform the action. Only one certificate can be provided per device.","required":true},"responses":{"202":{"content":{"application/json":{"examples":{"Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Enroll a certificate on a device )":{"value":{"action":"ENROLL","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}],"metadata":{"task":{"description":"Device certificate management task queued","id":"8589936887","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887"},"status":"200","taskType":"MANAGE_CERTIFICATE"}}}},"Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Re-enroll a certificate on a device )":{"value":{"action":"RE_ENROLL","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}],"metadata":{"task":{"description":"Device certificate management task queued","id":"8589936887","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887"},"status":"200","taskType":"MANAGE_CERTIFICATE"}}}},"Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Refresh a certificate on a device )":{"value":{"action":"REFRESH","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}],"metadata":{"task":{"description":"Device certificate management task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887"},"status":"200","taskType":"MANAGE_CERTIFICATE"}}}},"Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Delete a certificate on a device )":{"value":{"action":"DELETE","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}],"metadata":{"task":{"description":"Device certificate management task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887"},"status":"200","taskType":"MANAGE_CERTIFICATE"}}}},"Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Export a certificate from a device )":{"value":{"action":"EXPORT","deviceCertificates":[{"certificates":[{"certificate":{"id":"7de01414-02b7-4693-acf1-8f30a92f2c1f","name":"certificate-1","type":"CertEnrollment"},"exportOptions":{"isPemFormat":false,"passPhrase":"test"}}],"deviceId":"00e5091a-ca4e-11eb-872b-edfdb3a31887"}],"metadata":{"task":{"description":"Device certificate management task queued","id":"93b2c18a-cb69-11eb-a8f1-27e3d065c679","links":{"self ":"/fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887"},"status":"200","taskType":"MANAGE_CERTIFICATE"}}}}},"schema":{"type":"object","properties":{"action":{"enum":["ENROLL","RE_ENROLL","REFRESH","DELETE","EXPORT"],"type":"string"},"description":{"type":"string"},"deviceCertificates":{"items":{"type":"object","properties":{"certificates":{"items":{"type":"object","properties":{"certificate":{"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"},"exportOptions":{"type":"object","properties":{"isPemFormat":{"type":"boolean"},"passPhrase":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceCertificateExportOptions"}},"$$ref":"#/components/schemas/ICertificateDetails"},"type":"array"},"deviceId":{"type":"string"}},"$$ref":"#/components/schemas/IDeviceCertificate"},"type":"array"},"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","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"},"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"},"task":{"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"},"message":{"type":"string"},"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"},"showDetailedDeviceStatus":{"type":"string"},"status":{"type":"string"},"subTasks":{"items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"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"},"status":{"type":"string"},"target":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","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":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"}},"$$ref":"#/components/schemas/ISubTask"},"type":"array"},"taskType":{"enum":["DEVICE_REGISTRATION","SMART_LICENSE","DEVICE_DEPLOYMENT","DEVICE_ROLLBACK","NGFWHA_OPERATIONS","COPY_CONFIG_REQUEST","HIT_COUNT_REFRESH","FTD_CLUSTER_BOOTSTRAP","FTD_CLUSTER_CREATE","FTD_CLUSTER_BREAK","FTD_CLUSTER_ADD_NODES","FTD_CLUSTER_REMOVE_NODES","DEVICE_BACKUP","FTD_CLUSTER_UPDATE_BOOTSTRAP","FTD_CLUSTER_COMMAND","SSP_EPM_OIR","SSP_EPM_BREAKOUT_DEPLOY","DEVICE_EXPORT","DEVICE_IMPORT","POLICY_EXPORT","CHASSIS_REGISTRATION","CHANGE_MANAGER","CONFIGURE_DEVICE_VALIDATE","CONFIGURE_DEVICE","CONFIGURE_MANAGER","CONFIGURE_MANAGER_ADD","CONFIGURE_MANAGER_DELETE","INITIATE_MIGRATION","DISCARD_MIGRATION","SWITCH_TO_ANALYTICS","DELETE_DEVICE","GENERATE_REPORTS","FLEXCONFIG_MIGRATION","DEVICE_UNREGISTRATION","PENDING_CHANGES_REQUEST","DEVICE_TROUBLESHOOT","DEVICE_MODEL_MIGRATION","DEVICE_TEMPLATE_CREATION","CHASSIS_CONVERSION_REQUEST","SNORT_PROFILER","CPU_PROFILER","POLICY_REPORT_GENERATION","DEVICE_TEMPLATE_APPLY","LTP_ONBOARDING","POLICY_CLONE_OPERATION","DEVICE_CERTIFICATE_MANAGEMENT","OOB_CHANGES_REQUEST","UPLOAD_TROUBLESHOOT","EXECUTE_BULK_COMMANDS","FA_TELEMETRY_DATA_GENERATION"],"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/TaskStatus"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/TaskMetadata"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ManageDeviceCertificatesRequestModel"}}},"description":"Accepted"},"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":["Devices"],"__originalOperationId":"createManageDeviceCertificatesRequestModel","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/operational/managecertificates"}}