{"type":"api","title":"Get User Enrichment Details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"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":"getUserEnrichmentDetails","tags":["Users"],"summary":"Get User Enrichment Details","deprecated":false,"description":"Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to","parameters":[{"name":"entity_type","description":"User 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":"__persistbapioutput","description":"For the enrichment details to be made available as part of the API response, this header must be set to true. This header must be explicitly passed when called from client applications outside Catalyst Center","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":"object","properties":{},"description":""},"hostName":{"type":"object","properties":{},"description":""},"hostOs":{"type":"object","properties":{},"description":""},"hostVersion":{"type":"object","properties":{},"description":""},"subType":{"type":"string","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":""},"frequency":{"type":"object","properties":{},"description":""},"channel":{"type":"object","properties":{},"description":""},"apGroup":{"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":""},"avgRssi":{"type":"object","properties":{},"description":""},"snr":{"type":"object","properties":{},"description":""},"avgSnr":{"type":"object","properties":{},"description":""},"dataRate":{"type":"object","properties":{},"description":""},"txBytes":{"type":"object","properties":{},"description":""},"rxBytes":{"type":"object","properties":{},"description":""},"dnsSuccess":{"type":"object","properties":{},"description":""},"dnsFailure":{"type":"object","properties":{},"description":""},"onboarding":{"type":"object","properties":{"averageRunDuration":{"type":"object","properties":{},"description":""},"maxRunDuration":{"type":"object","properties":{},"description":""},"averageAssocDuration":{"type":"object","properties":{},"description":""},"maxAssocDuration":{"type":"object","properties":{},"description":""},"averageAuthDuration":{"type":"object","properties":{},"description":""},"maxAuthDuration":{"type":"object","properties":{},"description":""},"averageDhcpDuration":{"type":"object","properties":{},"description":""},"maxDhcpDuration":{"type":"object","properties":{},"description":""},"aaaServerIp":{"type":"object","properties":{},"description":""},"dhcpServerIp":{"type":"object","properties":{},"description":""}},"description":""},"onboardingTime":{"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":"object","properties":{},"description":""},"macAddress":{"type":"string","description":""},"role":{"type":"string","description":""},"apManagerInterfaceIp":{"type":"string","description":""},"associatedWlcIp":{"type":"string","description":""},"bootDateTime":{"type":"string","description":""},"collectionStatus":{"type":"string","description":""},"interfaceCount":{"type":"string","description":""},"lineCardCount":{"type":"string","description":""},"lineCardId":{"type":"string","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":"object","properties":{},"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":{"errorCode":{"type":"integer","description":""},"message":{"type":"string","description":""},"detail":{"type":"string","description":""}}},"description":""}},"description":""}}},"description":""}}},"description":"","$$ref":"#/components/schemas/GetUserEnrichmentDetailsResponse"}}}},"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":"d7a6-3928-45e8-969d","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 and devices that the user is connected to","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Users","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"getUserEnrichmentDetails","method":"get","path":"/dna/intent/api/v1/user-enrichment-details"}}