Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_ClientDetails

# GET ClientDetails

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

Represents the detail view of a client. It provides attributes of client device, security information, connected device, traffic and session information. All information is collected in current or last session.

## Resource URL

/webacs/api/v1/data/ClientDetails

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
String | adDomainName | AD domain name accquired from Cisco Identity Service Engine
String | apIpAddress | Associated AP IP address
String | apMacAddress | Associated AP MAC address
String | apName | Associated AP name
int | apSlotId | Slot ID of the associated radio in the AP
long | associationTime | Current or last session start time in unix format
String | auditSessionId | Client audit session ID
AuthenticationAlgorithmEnum | authenticationAlgorithm | Client authentication algorithm Allowed values: OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
String | authnTimeStamp | Authorization time stamp accquired from Cisco Identity Service Engine
String | authorizationPolicy | Authorization Policy accquired from Cisco Identity Service Engine
String | authorizedBy |
long | bytesReceived | Number of bytes received during the current or last session
long | bytesSent | Nunber of bytes sent during the current or last session
CcxFSVersionEnum | ccxFSVersion | CCX FS version of the clinet card Allowed values: UNSUPPORTED V1 V2
CcxFSVersionEnum | ccxLSVersion | CCX LS version of the client card Allowed values: UNSUPPORTED V1 V2
CcxFSVersionEnum | ccxMSVersion | CCX MS version of the client card Allowed values: UNSUPPORTED V1 V2
CcxFSVersionEnum | ccxVSVersion | CCX VS version of teh client card Allowed values: UNSUPPORTED V1 V2
CCXVersionEnum | ccxVersion | CCX version of the client card Allowed values: UNSUPPORTED V1 V2 V3 V4 V5 V6
ClientAclAppliedEnum | clientAaaOverrideAclApplied | Flag indicating whether AAA override ACL is applied to the client Allowed values: YES NO NA
String | clientAaaOverrideAclName | AAA override ACL name applied to the client
ClientAclAppliedEnum | clientAclApplied | Flag indicating whether ACL applied to the client Allowed values: YES NO NA
String | clientAclName | ACL name applied to the client
ClientApModeEnum | clientApMode | Client AP mode Allowed values: LOCAL MONITOR HREAP ROGUEDETECTOR UNKNOWN
String | clientInterface | Client Interface
String | clientRedirectUrl | Redirect URL applied to the client
ConnectionTypeEnum | connectionType | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values: LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
String | ctsSecurityGroup | client CTS security group accquired from Cisco Identity Service Engine
String | deviceIpAddress | Associated device IP address
String | deviceName | Associated device name (controller or switch)
String | deviceType | Client device type identified and accquired from Cisco Identity Service Engine
EapTypeEnum | eapType | EAP type Allowed values: EAPTLS TTLS PEAP LEAP SPEKE EAPFAST NA UNNOWN MD5 EAPSIM
EncryptionCypherEnum | encryptionCypher | Client encryption cypher Allowed values: CCMPAES TKIPMIC LITERAL2 WEP140 WEP128 NONE NA UNKNOWN
String | failureCode | Failure code accquired from Cisco Identity Service Engine
String | failureStep | Failure step accquired from Cisco Identity Service Engine
long | firstSeenTime | Time of the client was discovered first time by the NCS in unix format
String | hostname | DNS reverse lpookup from client IP address
String | hreapLocallyAuthenticated | Flag indicating whether the client is authenticated via HREAP
String | ifDescr | SNMP ifDescr if the switch that the client is connected to
int | ifIndex | SNMP ifIndex of the switch that the client is connected to
String | ipAddress | Client IP address
IpTypeEnum | ipType | Client IP type (IPv4, IPv6 or Dual-Stack) Allowed values: IPV4 IPV6 DUALSTACK NOTDETECTED
String | iseName | ISE (Cisco Identity Service Engine) name which the client is reported
String | location | MAP location
String | macAddress | Client MAC address
MobilityStatusEnum | mobilityStatus | Client mobility status (local, anchored, export anchored) Allowed values: UNASSOCIATED LOCAL ANCHORED FOREIGN HANDOFF UNKNOWN EXPORTANCHORED EXPORTFOREIGN
NACState | nacState | Client NAC state Allowed values: NA INVALID QUARANTINE ACCESS
long | packetsReceived | Number of packets received during the current or last session
long | packetsSent | Number of packets sent during the current or last session
SecurityPolicyEnum | policyType | Security policy type Allowed values: DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN MACAUTHBYPASS WEBAUTH WPA
PolicyTypeStatusEnum | policyTypeStatus | Client policy type status accquired from Cisco Identity Service Engine Allowed values: IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
PostureStatusEnum | postureStatus | Client posture status accquired from Cisco Identity Service Engine Allowed values: UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
ClientProtocolEnum | protocol | client connection protocol (802.11a, 802.11b, 802.11g, 802.11n or 802.3) Allowed values: DOT11A DOT11B DOT11G UNKNOWN MOBILE DOT11N2_4GNZ DOT11N5GHZ DOT3
String | radiusResponse | Radius server response accquired from Cisco Identity Service Engine
int | rssi | RSSI value last polled during the session
SecurityPolicyStatusEnum | securityPolicyStatus | status whether the client is on network (in running state) Allowed values: PASSED FAILED
int | snr | SNR value last polled during the session
ClientSpeedEnum | speed | The port speed that the client is connected to Allowed values: UNKNOWN SPEED10M SPEED100M SPEED1G
String | ssid | SSID
ClientStatusEnum | status | Status of the client connection Allowed values: IDLE AUTHPENDING AUTHENTICATED ASSOCIATED POWERSAVE DISASSOCIATED TOBEDELETED PROBING BLACKLISTED NOTCONFIGURED UNAUTHENTICATED
double | throughput | average throughput during the current or last session
long | traffic | Total traffic during the session
String | userName | Client username
String | vendor | Vendor name of the client card derived from OUI mapping
String | vlan | VLAN ID
WebSecurityEnum | webSecurity | flag to indicate whether the client is authentocated via WebAuth Allowed values: DISABLED ENABLED
WepStateEnum | wepState | Client WEP state Allowed values: NA ENABLED DISABLED
String | wgbMacAddress |
WGBStatusEnum | wgbStatus | Client WGB status (WGB client, WGB AP or local client) Allowed values: REGULARCLIENT WGBCLIENT WGBAP
WiredClientType | wiredClientType | Wired client type Allowed values: NA WIREDGUEST WGB EVORA

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

## Sample XML Payload

https://192.168.116.207/webacs/api/v1/data/ClientDetails/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/ClientDetails/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="clientDetailsDTO_$$_javassist_5987">
            <clientDetailsDTO id="15" displayName="String value">
                <adDomainName>String value</adDomainName>
                <apIpAddress>String value</apIpAddress>
                <apMacAddress>String value</apMacAddress>
                <apName>String value</apName>
                <apSlotId>1</apSlotId>
                <associationTime>2</associationTime>
                <auditSessionId>String value</auditSessionId>
                <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
                <authnTimeStamp>String value</authnTimeStamp>
                <authorizationPolicy>String value</authorizationPolicy>
                <authorizedBy>String value</authorizedBy>
                <bytesReceived>2</bytesReceived>
                <bytesSent>2</bytesSent>
                <ccxFSVersion>UNSUPPORTED</ccxFSVersion>
                <ccxLSVersion>UNSUPPORTED</ccxLSVersion>
                <ccxMSVersion>UNSUPPORTED</ccxMSVersion>
                <ccxVSVersion>UNSUPPORTED</ccxVSVersion>
                <ccxVersion>UNSUPPORTED</ccxVersion>
                <clientAaaOverrideAclApplied>YES</clientAaaOverrideAclApplied>
                <clientAaaOverrideAclName>String value</clientAaaOverrideAclName>
                <clientAclApplied>YES</clientAclApplied>
                <clientAclName>String value</clientAclName>
                <clientApMode>LOCAL</clientApMode>
                <clientInterface>String value</clientInterface>
                <clientRedirectUrl>String value</clientRedirectUrl>
                <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
                <ctsSecurityGroup>String value</ctsSecurityGroup>
                <deviceIpAddress>String value</deviceIpAddress>
                <deviceName>String value</deviceName>
                <deviceType>String value</deviceType>
                <eapType>EAPTLS</eapType>
                <encryptionCypher>CCMPAES</encryptionCypher>
                <failureCode>String value</failureCode>
                <failureStep>String value</failureStep>
                <firstSeenTime>2</firstSeenTime>
                <hostname>String value</hostname>
                <hreapLocallyAuthenticated>String value</hreapLocallyAuthenticated>
                <ifDescr>String value</ifDescr>
                <ifIndex>1</ifIndex>
                <ipAddress>String value</ipAddress>
                <ipType>IPV4</ipType>
                <iseName>String value</iseName>
                <location>String value</location>
                <macAddress>String value</macAddress>
                <mobilityStatus>UNASSOCIATED</mobilityStatus>
                <nacState>INVALID</nacState>
                <packetsReceived>2</packetsReceived>
                <packetsSent>2</packetsSent>
                <policyType>DOT1X</policyType>
                <policyTypeStatus>IDLE</policyTypeStatus>
                <postureStatus>UNKNOWN</postureStatus>
                <protocol>DOT11A</protocol>
                <radiusResponse>String value</radiusResponse>
                <rssi>1</rssi>
                <securityPolicyStatus>PASSED</securityPolicyStatus>
                <snr>1</snr>
                <speed>UNKNOWN</speed>
                <ssid>String value</ssid>
                <status>IDLE</status>
                <throughput>4.0</throughput>
                <traffic>2</traffic>
                <userName>String value</userName>
                <vendor>String value</vendor>
                <vlan>String value</vlan>
                <webSecurity>DISABLED</webSecurity>
                <wepState>NA</wepState>
                <wgbMacAddress>String value</wgbMacAddress>
                <wgbStatus>REGULARCLIENT</wgbStatus>
                <wiredClientType>NA</wiredClientType>
            </clientDetailsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/ClientDetails/42.json

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/ClientDetails\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "clientDetailsDTO_$$_javassist_5987",
          "clientDetailsDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "adDomainName" : "String value",
            "apIpAddress" : "String value",
            "apMacAddress" : "String value",
            "apName" : "String value",
            "apSlotId" : 1,
            "associationTime" : 2,
            "auditSessionId" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authnTimeStamp" : "String value",
            "authorizationPolicy" : "String value",
            "authorizedBy" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "ccxFSVersion" : "UNSUPPORTED",
            "ccxLSVersion" : "UNSUPPORTED",
            "ccxMSVersion" : "UNSUPPORTED",
            "ccxVSVersion" : "UNSUPPORTED",
            "ccxVersion" : "UNSUPPORTED",
            "clientAaaOverrideAclApplied" : "YES",
            "clientAaaOverrideAclName" : "String value",
            "clientAclApplied" : "YES",
            "clientAclName" : "String value",
            "clientApMode" : "LOCAL",
            "clientInterface" : "String value",
            "clientRedirectUrl" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceIpAddress" : "String value",
            "deviceName" : "String value",
            "deviceType" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "failureCode" : "String value",
            "failureStep" : "String value",
            "firstSeenTime" : 2,
            "hostname" : "String value",
            "hreapLocallyAuthenticated" : "String value",
            "ifDescr" : "String value",
            "ifIndex" : 1,
            "ipAddress" : "String value",
            "ipType" : "IPV4",
            "iseName" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "mobilityStatus" : "UNASSOCIATED",
            "nacState" : "INVALID",
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "policyType" : "DOT1X",
            "policyTypeStatus" : "IDLE",
            "postureStatus" : "UNKNOWN",
            "protocol" : "DOT11A",
            "radiusResponse" : "String value",
            "rssi" : 1,
            "securityPolicyStatus" : "PASSED",
            "snr" : 1,
            "speed" : "UNKNOWN",
            "ssid" : "String value",
            "status" : "IDLE",
            "throughput" : 4,
            "traffic" : 2,
            "userName" : "String value",
            "vendor" : "String value",
            "vlan" : "String value",
            "webSecurity" : "DISABLED",
            "wepState" : "NA",
            "wgbMacAddress" : "String value",
            "wgbStatus" : "REGULARCLIENT",
            "wiredClientType" : "NA"
          }
        }
      }
    }