Create Certificate Map Model - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Certificate Map 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":"**Create a certificate map. _Check the response section for applicable examples (if any)._**","operationId":"createCertificateMapModel","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":{"schema":{"type":"object","description":"Certificate Map objects are a named set of certificate matching rules. These objects are used to provide an association between a received certificate and a Remote Access VPN connection profile.","properties":{"description":{"type":"string"},"id":{"description":"Unique identifier representing the CertificateMap object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata attributes for the CertificateMap.","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-specified name of the Certificate Map","type":"string"},"rules":{"items":{"type":"object","description":"Specify the contents of the certificate to evaluate.","properties":{"component":{"description":"Component of the client certificate to use for the matching rule.","enum":["WHOLE_FIELD","COUNTRY","COMMON_NAME","DN_QUALIFIER","EMAIL_ADDRESS","GENERATIONAL_QUALIFIER","GIVEN_NAME","INITIALS","LOCALITY","NAME","ORGANISATION","ORGANISATIONAL_UNIT","SERIAL_NUMBER","SURNAME","STATE_PROVINCE","TITLE","USER_ID","UNSTRUCTURED_NAME","IP_ADDRESS","DOMAIN_COMPONENT"],"type":"string"},"field":{"description":"Field for the matching rule according to the Subject or the Issuer of the client certificate.","enum":["SUBJECT","ALTERNATIVE_SUBJECT","ISSUER","EXTENDED_KEY_USAGE"],"type":"string"},"operator":{"description":"Operator for the matching rule as Equals, Contains, Does Not Equal or Does Not Contain.","enum":["EQUALS","CONTAINS","DOES_NOT_EQUAL","DOES_NOT_CONTAIN"],"type":"string"},"value":{"description":"The value of the matching rule. The value is associated with the selected component and operator.","type":"string"}},"required":["component","field","operator","value"],"$$ref":"#/components/schemas/ICertificateMapRules"},"type":"array"},"type":{"description":"Type associated with resource: CertificateMap.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/CertificateMapModel"}}},"description":"Input representation of Certificate Map object.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","description":"Certificate Map objects are a named set of certificate matching rules. These objects are used to provide an association between a received certificate and a Remote Access VPN connection profile.","properties":{"description":{"type":"string"},"id":{"description":"Unique identifier representing the CertificateMap object.","type":"string"},"links":{"description":"Object containing related links.","type":"object","properties":{"parent":{"type":"string"},"self":{"type":"string"}},"$$ref":"#/components/schemas/Links"},"metadata":{"description":"Object representing metadata attributes for the CertificateMap.","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-specified name of the Certificate Map","type":"string"},"rules":{"items":{"type":"object","description":"Specify the contents of the certificate to evaluate.","properties":{"component":{"description":"Component of the client certificate to use for the matching rule.","enum":["WHOLE_FIELD","COUNTRY","COMMON_NAME","DN_QUALIFIER","EMAIL_ADDRESS","GENERATIONAL_QUALIFIER","GIVEN_NAME","INITIALS","LOCALITY","NAME","ORGANISATION","ORGANISATIONAL_UNIT","SERIAL_NUMBER","SURNAME","STATE_PROVINCE","TITLE","USER_ID","UNSTRUCTURED_NAME","IP_ADDRESS","DOMAIN_COMPONENT"],"type":"string"},"field":{"description":"Field for the matching rule according to the Subject or the Issuer of the client certificate.","enum":["SUBJECT","ALTERNATIVE_SUBJECT","ISSUER","EXTENDED_KEY_USAGE"],"type":"string"},"operator":{"description":"Operator for the matching rule as Equals, Contains, Does Not Equal or Does Not Contain.","enum":["EQUALS","CONTAINS","DOES_NOT_EQUAL","DOES_NOT_CONTAIN"],"type":"string"},"value":{"description":"The value of the matching rule. The value is associated with the selected component and operator.","type":"string"}},"required":["component","field","operator","value"],"$$ref":"#/components/schemas/ICertificateMapRules"},"type":"array"},"type":{"description":"Type associated with resource: CertificateMap.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/CertificateMapModel"}}},"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":"createCertificateMapModel","method":"post","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/certificatemaps"}}