VpnCertEnrollmentModel - Security Cloud Control Firewall Manager API Documentation

{"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":{"description":"A model representing Certificate Enrollment Object definition.","properties":{"caCertificate":{"description":"Specifies CA Certificate info in base64 format for Manual enroll type and CA flag","type":"object","properties":{"base64Content":{"description":"represents CA Certificate in Base64 format.","type":"string"},"caOnly":{"description":"Optional. Represents whether the certfiicate enrollment object contains only CA Certificate and no Identity Certificate. Default is false.","type":"boolean"}},"$$ref":"#/components/schemas/ICertEnrollManualCaCertificateModel"},"certificateParameters":{"type":"object","properties":{"commonName":{"type":"string"},"countryCode":{"type":"string"},"customFqdn":{"type":"string"},"email":{"type":"string"},"includeDeviceIp":{"type":"string"},"includeDeviceSerial":{"type":"boolean"},"includeFQDN":{"enum":["DEVICE_HOSTNAME","NONE","CUSTOM","DEFAULT"],"type":"string"},"locality":{"type":"string"},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"state":{"type":"string"}},"$$ref":"#/components/schemas/ICertificateParametersModel"},"description":{"description":"User provided resource description.","type":"string"},"enrollmentType":{"description":"User chosen enrollment type.Possible values are SCEP/EST/Manual/SelfSignedCertficate/Pkcs12.","enum":["SCEP","EST","MANUAL","SELF_SIGNED_CERTFICATE","PKCS12"],"type":"string"},"estContent":{"type":"object","properties":{"enrollmentUrl":{"type":"string"},"fingerprint":{"type":"string"},"ignoreServerCertificateValidations":{"type":"boolean"},"password":{"type":"string"},"sourceInterface":{"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"},"username":{"type":"string"}},"$$ref":"#/components/schemas/IVpnEstContentModel"},"id":{"description":"Unique identifier of response object.","type":"string"},"key":{"type":"object","properties":{"ignoreIpsecKeyusage":{"type":"boolean"},"keyName":{"type":"string"},"keySize":{"enum":["CertKey_512","CertKey_768","CertKey_1024","CertKey_2048","CertKey_3072","CertKey_4096","CertKey_256","CertKey_384","CertKey_521"],"type":"string"},"keyType":{"enum":["RSA","ECDSA","EdDSA"],"type":"string"}},"$$ref":"#/components/schemas/IPKIServerKeyModel"},"links":{"type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata properties of response object.","type":"object","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"},"overridable":{"description":"Boolean indicating whether object values can be overridden.","type":"boolean"},"overrides":{"type":"object","description":"Defines the override details for this object.","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","type":"object","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"},"target":{"description":"The device or the domain target on which this override is enabled.","type":"object","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"}},"$$ref":"#/components/schemas/IOverride"},"pkcs12Content":{"description":"Specifies PKCS12 certificate in base64 format and the passPhrase.","type":"object","properties":{"base64Certificate":{"description":"represents PKCS12 file content in Base64 format.","type":"string"},"passPhrase":{"description":"represents pass phrase value for decryption. ","type":"string"}},"$$ref":"#/components/schemas/IVpnPkcs12ContentModel"},"revocation":{"type":"object","properties":{"certRevocationListContent":{"type":"object","properties":{"certRevocationStaticUrlList":{"items":{"type":"string"},"type":"array"},"enableCertRevocationList":{"type":"boolean"},"enableCertRevocationListDistributionPoint":{"type":"boolean"},"enableStaticCertRevocationList":{"type":"boolean"}},"$$ref":"#/components/schemas/IPKICertRevocationListModel"},"evaluationPriority":{"enum":["CRL","OCSP","NONE"],"type":"string"},"ignoreRevocation":{"type":"boolean"},"onlineCertificateStatusProtocolContent":{"type":"object","properties":{"enableOnlineCertificateStatusProtocol":{"type":"boolean"},"onlineCertificateStatusProtocolUrl":{"type":"string"}},"$$ref":"#/components/schemas/IPKIOnlineCertificateStatusProtocolModel"}},"$$ref":"#/components/schemas/IPKIRevocationModel"},"scepContent":{"type":"object","properties":{"challengePassword":{"type":"string"},"enrollmentUrl":{"type":"string"},"fingerprint":{"type":"string"},"retryCount":{"type":"string"},"retryPeriodInMins":{"type":"string"}},"$$ref":"#/components/schemas/IVpnScepContentModel"},"skipCaFlagCheck":{"description":"Specifices flag to skip checking the basic constraints extension and the CA flag in a trustpoint certificate.","type":"boolean"},"subType":{"enum":["SA_CLIENT_CERT_CA_CHAIN","SA_REDIRECT_TOKEN_SIGN_CERT","SA_REDIRECT_TOKEN_ENCRYPT_CERT_KEY","SA_ROOT_CA","SA_INTERMEDIATE_CA","SA_ORG_CA"],"type":"string"},"type":{"description":"Type associated with resource: CertEnrollment.","type":"string"},"validationUsage":{"type":"object","properties":{"ipsecClient":{"type":"boolean"},"sslClient":{"type":"boolean"},"sslServer":{"type":"boolean"}},"$$ref":"#/components/schemas/IPKIValidationUsageModel"},"version":{"type":"string"}},"type":"object","title":"VpnCertEnrollmentModel"}}