{"type":"api","title":"Get User Enrichment Details","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"getUserEnrichmentDetails","tags":["Users"],"summary":"Get User 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 and devices that the user is connected to","consumes":["application/json"],"produces":["application/json"],"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","default":"","required":true,"type":"string","in":"header"},{"name":"entity_value","description":"Contains the actual value for the entity type that has been defined","default":"","required":true,"type":"string","in":"header"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"array","items":{"type":"object","properties":{"userDetails":{"type":"object","properties":{"id":{"type":"string"},"connectionStatus":{"type":"string"},"hostType":{"type":"string"},"userId":{"type":"object","properties":{}},"hostName":{"type":"object","properties":{}},"hostOs":{"type":"object","properties":{}},"hostVersion":{"type":"object","properties":{}},"subType":{"type":"string"},"lastUpdated":{"type":"integer"},"healthScore":{"type":"array","items":{"type":"object","properties":{"healthType":{"type":"string"},"reason":{"type":"string"},"score":{"type":"integer"}}}},"hostMac":{"type":"string"},"hostIpV4":{"type":"string"},"hostIpV6":{"type":"array","items":{"type":"object"}},"authType":{"type":"object","properties":{}},"vlanId":{"type":"string"},"ssid":{"type":"object","properties":{}},"frequency":{"type":"object","properties":{}},"channel":{"type":"object","properties":{}},"apGroup":{"type":"object","properties":{}},"location":{"type":"object","properties":{}},"clientConnection":{"type":"string"},"connectedDevice":{"type":"array","items":{"type":"object"}},"issueCount":{"type":"number"},"rssi":{"type":"object","properties":{}},"avgRssi":{"type":"object","properties":{}},"snr":{"type":"object","properties":{}},"avgSnr":{"type":"object","properties":{}},"dataRate":{"type":"object","properties":{}},"txBytes":{"type":"object","properties":{}},"rxBytes":{"type":"object","properties":{}},"dnsSuccess":{"type":"object","properties":{}},"dnsFailure":{"type":"object","properties":{}},"onboarding":{"type":"object","properties":{"averageRunDuration":{"type":"object","properties":{}},"maxRunDuration":{"type":"object","properties":{}},"averageAssocDuration":{"type":"object","properties":{}},"maxAssocDuration":{"type":"object","properties":{}},"averageAuthDuration":{"type":"object","properties":{}},"maxAuthDuration":{"type":"object","properties":{}},"averageDhcpDuration":{"type":"object","properties":{}},"maxDhcpDuration":{"type":"object","properties":{}},"aaaServerIp":{"type":"object","properties":{}},"dhcpServerIp":{"type":"object","properties":{}}}},"onboardingTime":{"type":"object","properties":{}},"port":{"type":"object","properties":{}}}},"connectedDevice":{"type":"array","items":{"type":"object","properties":{"deviceDetails":{"type":"object","properties":{"family":{"type":"string"},"type":{"type":"string"},"location":{"type":"object","properties":{}},"errorCode":{"type":"object","properties":{}},"macAddress":{"type":"string"},"role":{"type":"string"},"apManagerInterfaceIp":{"type":"string"},"associatedWlcIp":{"type":"string"},"bootDateTime":{"type":"string"},"collectionStatus":{"type":"string"},"interfaceCount":{"type":"string"},"lineCardCount":{"type":"string"},"lineCardId":{"type":"string"},"managementIpAddress":{"type":"string"},"memorySize":{"type":"string"},"platformId":{"type":"string"},"reachabilityFailureReason":{"type":"string"},"reachabilityStatus":{"type":"string"},"snmpContact":{"type":"string"},"snmpLocation":{"type":"string"},"tunnelUdpPort":{"type":"object","properties":{}},"waasDeviceMode":{"type":"object","properties":{}},"series":{"type":"string"},"inventoryStatusDetail":{"type":"string"},"collectionInterval":{"type":"string"},"serialNumber":{"type":"string"},"softwareVersion":{"type":"string"},"roleSource":{"type":"string"},"hostname":{"type":"string"},"upTime":{"type":"string"},"lastUpdateTime":{"type":"integer"},"errorDescription":{"type":"object","properties":{}},"locationName":{"type":"object","properties":{}},"tagCount":{"type":"string"},"lastUpdated":{"type":"string"},"instanceUuid":{"type":"string"},"id":{"type":"string"},"neighborTopology":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"integer"},"message":{"type":"string"},"detail":{"type":"string"}}}}}}}}}}},"$$ref":"#/definitions/GetUserEnrichmentDetailsResponse"}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"404":{"description":"The client made a request for a resource that does not exist."},"500":{"description":"The server could not fulfill the request."}},"__originalOperationId":"getUserEnrichmentDetails","method":"get","path":"/dna/intent/api/v1/user-enrichment-details"}}