{"type":"api","title":"Get Client Enrichment Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-6/abf92d064d2ae44ab6837c3d88edf9d690a3dafe/e781f25e-db90-3cf3-87fc-525e5b8797c6","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.6","version":"2.3.7.6"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getClientEnrichmentDetails","tags":["Clients"],"summary":"Get Client Enrichment Details","description":"Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by","parameters":[{"name":"entity_type","description":"Client enrichment details can be fetched based on either User ID or Client MAC address. This parameter value must either be network_user_id/mac_address","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"entity_value","description":"Contains the actual value for the entity type that has been defined","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"issueCategory","description":"The category of the DNA event based on which the underlying issues need to be fetched","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"__persistbapioutput","description":"","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"header"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"userDetails":{"type":"object","properties":{"id":{"type":"string","description":""},"connectionStatus":{"type":"string","description":""},"hostType":{"type":"string","description":""},"userId":{"type":"string","description":""},"hostName":{"type":"object","properties":{},"description":""},"hostOs":{"type":"object","properties":{},"description":""},"hostVersion":{"type":"object","properties":{},"description":""},"subType":{"type":"object","properties":{},"description":""},"lastUpdated":{"type":"integer","description":""},"healthScore":{"type":"array","items":{"type":"object","properties":{"healthType":{"type":"string","description":""},"reason":{"type":"string","description":""},"score":{"type":"integer","description":""}}},"description":""},"hostMac":{"type":"string","description":""},"hostIpV4":{"type":"string","description":""},"hostIpV6":{"type":"array","items":{"type":"object"},"description":""},"authType":{"type":"object","properties":{},"description":""},"vlanId":{"type":"string","description":""},"ssid":{"type":"object","properties":{},"description":""},"location":{"type":"object","properties":{},"description":""},"clientConnection":{"type":"string","description":""},"connectedDevice":{"type":"array","items":{"type":"object"},"description":""},"issueCount":{"type":"number","description":""},"rssi":{"type":"object","properties":{},"description":""},"snr":{"type":"object","properties":{},"description":""},"dataRate":{"type":"object","properties":{},"description":""},"port":{"type":"object","properties":{},"description":""}},"description":""},"connectedDevice":{"type":"array","items":{"type":"object","properties":{"deviceDetails":{"type":"object","properties":{"family":{"type":"string","description":""},"type":{"type":"string","description":""},"location":{"type":"object","properties":{},"description":""},"errorCode":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"role":{"type":"string","description":""},"apManagerInterfaceIp":{"type":"string","description":""},"associatedWlcIp":{"type":"string","description":""},"bootDateTime":{"type":"object","properties":{},"description":""},"collectionStatus":{"type":"string","description":""},"interfaceCount":{"type":"object","properties":{},"description":""},"lineCardCount":{"type":"object","properties":{},"description":""},"lineCardId":{"type":"object","properties":{},"description":""},"managementIpAddress":{"type":"string","description":""},"memorySize":{"type":"string","description":""},"platformId":{"type":"string","description":""},"reachabilityFailureReason":{"type":"string","description":""},"reachabilityStatus":{"type":"string","description":""},"snmpContact":{"type":"string","description":""},"snmpLocation":{"type":"string","description":""},"tunnelUdpPort":{"type":"string","description":""},"waasDeviceMode":{"type":"object","properties":{},"description":""},"series":{"type":"string","description":""},"inventoryStatusDetail":{"type":"string","description":""},"collectionInterval":{"type":"string","description":""},"serialNumber":{"type":"string","description":""},"softwareVersion":{"type":"string","description":""},"roleSource":{"type":"string","description":""},"hostname":{"type":"string","description":""},"upTime":{"type":"string","description":""},"lastUpdateTime":{"type":"integer","description":""},"errorDescription":{"type":"object","properties":{},"description":""},"locationName":{"type":"object","properties":{},"description":""},"tagCount":{"type":"string","description":""},"lastUpdated":{"type":"string","description":""},"instanceUuid":{"type":"string","description":""},"id":{"type":"string","description":""},"neighborTopology":{"type":"array","items":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":""},"name":{"type":"string","description":""},"id":{"type":"string","description":""},"description":{"type":"string","description":""},"deviceType":{"type":"object","properties":{},"description":""},"platformId":{"type":"object","properties":{},"description":""},"family":{"type":"object","properties":{},"description":""},"ip":{"type":"object","properties":{},"description":""},"softwareVersion":{"type":"object","properties":{},"description":""},"userId":{"type":"object","properties":{},"description":""},"nodeType":{"type":"object","properties":{},"description":""},"radioFrequency":{"type":"object","properties":{},"description":""},"clients":{"type":"number","description":""},"count":{"type":"object","properties":{},"description":""},"healthScore":{"type":"object","properties":{},"description":""},"level":{"type":"number","description":""},"fabricGroup":{"type":"object","properties":{},"description":""}}},"description":""},"links":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":""},"linkStatus":{"type":"string","description":""},"label":{"type":"array","items":{"type":"object"},"description":""},"target":{"type":"string","description":""},"id":{"type":"object","properties":{},"description":""},"portUtilization":{"type":"object","properties":{},"description":""}}},"description":""}}},"description":""},"cisco360view":{"type":"string","description":""}},"description":""}}},"description":""},"issueDetails":{"type":"object","properties":{"issue":{"type":"array","items":{"type":"object","properties":{"issueId":{"type":"string","description":""},"issueSource":{"type":"string","description":""},"issueCategory":{"type":"string","description":""},"issueName":{"type":"string","description":""},"issueDescription":{"type":"string","description":""},"issueEntity":{"type":"string","description":""},"issueEntityValue":{"type":"string","description":""},"issueSeverity":{"type":"string","description":""},"issuePriority":{"type":"string","description":""},"issueSummary":{"type":"string","description":""},"issueTimestamp":{"type":"integer","description":""},"suggestedActions":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":""},"steps":{"type":"array","items":{"type":"object"},"description":""}}},"description":""},"impactedHosts":{"type":"array","items":{"type":"object","properties":{"hostType":{"type":"string","description":""},"hostName":{"type":"string","description":""},"hostOs":{"type":"string","description":""},"ssid":{"type":"string","description":""},"connectedInterface":{"type":"string","description":""},"macAddress":{"type":"string","description":""},"failedAttempts":{"type":"integer","description":""},"location":{"type":"object","properties":{"siteId":{"type":"string","description":""},"siteType":{"type":"string","description":""},"area":{"type":"string","description":""},"building":{"type":"string","description":""},"floor":{"type":"object","properties":{},"description":""},"apsImpacted":{"type":"array","items":{"type":"object"},"description":""}},"description":""},"timestamp":{"type":"integer","description":""}}},"description":""}}},"description":""}},"description":""}}},"description":"","$$ref":"#/components/schemas/GetClientEnrichmentDetailsResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"b199-685d-4d08-9a67","x-rapi-overview":"Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Clients","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"getClientEnrichmentDetails","method":"get","path":"/dna/intent/api/v1/client-enrichment-details"}}