Get Distinguished Name - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get Distinguished Name","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 Distinguished Names.**","operationId":"getDistinguishedName","parameters":[{"description":"Name of the Distinguished Name.","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/distinguishednames?limit=2 ( Get all distinguished names with limit set to 2 )":{"value":{"items":[{"id":"7fa4067e-62f2-3ed7-9d38-f3bde65f7e50","name":"CN_time-ios.apple.com","type":"DistinguishedName"},{"id":"42fd2ace-8ea7-3972-9cfb-a9a8d561a92f","name":"CN_ocsp.entrust.net","type":"DistinguishedName"}],"links":{"self":"https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=0&limit=2"},"paging":{"count":69,"limit":2,"next":["https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=2&limit=2","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=4&limit=2","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=6&limit=2","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=8&limit=2"],"offset":0,"pages":35}}},"Example 2 : GET /fmc_config/v1/domain/domainUUID/object/distinguishednames?limit=2&expanded=true ( Get all distinguished names with limit set to 2 and expanded set to true )":{"value":{"items":[{"dn":"C=AB,CN=aBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","id":"d136af2c-06cc-11ed-947f-06334677d29c","name":"test2","type":"DistinguishedName"},{"dn":"CN=crl4.digicert.com","id":"09e148dc-c6b4-3821-8c57-45c72f93e860","name":"CN_crl4.digicert.com","type":"DistinguishedName"}],"links":{"self":"https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=0&limit=2&expanded=true"},"paging":{"count":69,"limit":2,"next":["https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=2&limit=2&expanded=true","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=4&limit=2&expanded=true","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=6&limit=2&expanded=true","https://172.29.182.90:10216/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/object/distinguishednames?offset=8&limit=2&expanded=true"],"offset":0,"pages":35}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Represents the distinguished name listed for a public key certificate's subject or issuer.","properties":{"description":{"type":"string"},"dn":{"description":"The value of the distinguished name.","type":"string"},"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"},"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"},"type":{"description":"Type of the response object. This value is always 'DistinguishedName'.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/DistinguishedName"},"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/DistinguishedNameListContainer"}}},"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":"getDistinguishedName","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/distinguishednames"}}