
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET ClientDetails

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.

Since Product Version: 1.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/data/ClientDetails

Deprecated

This version has been deprecated due to poor performance in large-scale environments. Please use v2.

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
apIpAddress String | Associated AP IP address
apMacAddress String | Associated AP MAC address
apName String | Associated AP name
apSlotId int | Slot ID of the associated radio in the AP
associationTime long | Current or last session start time, measured in milliseconds since the Unix epoch.
auditSessionId String | Client audit session ID
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authnTimeStamp String | Authorization time stamp acquired from Cisco Identity Service Engine
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
authorizedBy String | Authorization provider
bytesReceived long | Number of bytes received during the current or last session
bytesSent long | Nunber of bytes sent during the current or last session
ccxFSVersion CcxFSVersionEnum | CCX FS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxLSVersion CcxFSVersionEnum | CCX LS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxMSVersion CcxFSVersionEnum | CCX MS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxVSVersion CcxFSVersionEnum | CCX VS version of teh client card Allowed values UNSUPPORTED NONE V1 V2
ccxVersion CCXVersionEnum | CCX version of the client card Allowed values UNSUPPORTED V1 V2 V3 V4 V5 V6
clientAaaOverrideAclApplied ClientAclAppliedEnum | Flag indicating whether AAA override ACL is applied to the client Allowed values YES NO NA
clientAaaOverrideAclName String | AAA override ACL name applied to the client
clientAclApplied ClientAclAppliedEnum | Flag indicating whether ACL applied to the client Allowed values YES NO NA
clientAclName String | ACL name applied to the client
clientApMode ClientApModeEnum | Client AP mode. The value UNKNOWN corresponds to the Sniffer mode. Allowed values LOCAL MONITOR HREAP ROGUEDETECTOR UNKNOWN BRIDGE SECONNECT FLEXPLUSBRIDGE REMOTEHYBRID SENSOR
clientInterface String | Client Interface
clientRedirectUrl String | Redirect URL applied to the client
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | Client CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress String | Associated device IP address
deviceName String | Associated device name (controller or switch)
deviceType String | Client device type identified and acquired from Cisco Identity Service Engine
eapType EapTypeEnum | EAP type Allowed values EAPTLS TTLS PEAP LEAP SPEKE EAPFAST NA UNNOWN MD5 EAPSIM
encryptionCypher EncryptionCypherEnum | Client encryption cypher Allowed values CCMPAES TKIPMIC LITERAL2 WEP140 WEP128 NONE NA UNKNOWN
failureCode String | Failure code acquired from Cisco Identity Service Engine
failureStep String | Failure step acquired from Cisco Identity Service Engine
firstSeenTime long | The time when the client was first discoved, measured in milliseconds since the Unix epoch.
hostname String | DNS reverse lookup from client IP address
hreapLocallyAuthenticated String | Flag indicating whether the client is authenticated via HREAP
ifDescr String | SNMP ifDescr if the switch that the client is connected to
ifIndex int | SNMP ifIndex of the switch that the client is connected to
ipAddress String | Client IP address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual-Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
iseName String | ISE (Cisco Identity Service Engine) name which the client is reported
location String | MAP location
macAddress String | Client MAC address
mobilityStatus MobilityStatusEnum | 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
packetsReceived long | Number of packets received during the current or last session
packetsSent long | Number of packets sent during the current or last session
policyType SecurityPolicyEnum | Security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
policyTypeStatus PolicyTypeStatusEnum | Client policy type status acquired from Cisco Identity Service Engine Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
protocol ClientProtocolEnum | Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3) Allowed values UNDEFINED DOT11A DOT11B DOT11G UNKNOWN MOBILE DOT11N2_4GNZ DOT11N5GHZ DOT3 DOT3GUEST DOT11AC DOT11AX5GHZ DOT11AX2_4GHZ
radiusResponse String | Radius server response acquired from Cisco Identity Service Engine
rssi int | RSSI value last polled during the session
securityPolicyStatus SecurityPolicyStatusEnum | Status whether the client is on network (in running state) Allowed values PASSED FAILED
snr int | SNR value last polled during the session
speed ClientSpeedEnum | The port speed that the client is connected to. For wireless clients the value of this attribute is UNKNOWN. Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
ssid String | SSID
status ClientStatusEnum | Status of the client connection Allowed values IDLE AUTHPENDING AUTHENTICATED ASSOCIATED POWERSAVE DISASSOCIATED TOBEDELETED PROBING BLACKLISTED NOTCONFIGURED UNAUTHENTICATED
throughput double | Average throughput during the current or last session
traffic long | Total traffic during the session
updateTime long | Last time this record was updated, measured in milliseconds since the Unix epoch.
userName String | Client username
vendor String | Vendor name of the client card derived from OUI mapping. Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
vlan String | ID of the vlan the client is connected to
vlanName String | Name of the vlan the client is connected to
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wepState WepStateEnum | Client WEP state Allowed values NA ENABLED DISABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | 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

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://10.64.88.203/webacs/api/v1/data/ClientDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/ClientDetails/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="clientDetailsDTO" type="ClientDetails" url="https://10.64.88.203/webacs/api/v1/data/ClientDetails/15">
        <clientDetailsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <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>
          <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>
          <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>
          <ifDescr>String value</ifDescr>
          <ifIndex>1</ifIndex>
          <ipType>IPV4</ipType>
          <iseName>String value</iseName>
          <location>String value</location>
          <mobilityStatus>UNASSOCIATED</mobilityStatus>
          <nacState>NA</nacState>
          <policyType>DOT1X</policyType>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <postureStatus>UNKNOWN</postureStatus>
          <protocol>UNDEFINED</protocol>
          <radiusResponse>String value</radiusResponse>
          <securityPolicyStatus>PASSED</securityPolicyStatus>
          <speed>UNKNOWN</speed>
          <ssid>String value</ssid>
          <status>IDLE</status>
          <updateTime>2</updateTime>
          <userName>String value</userName>
          <vendor>String value</vendor>
          <vlanName>String value</vlanName>
          <webSecurity>DISABLED</webSecurity>
          <wepState>NA</wepState>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <wiredClientType>NA</wiredClientType>
          <apIpAddress>String value</apIpAddress>
          <apMacAddress>String value</apMacAddress>
          <bytesReceived>2</bytesReceived>
          <bytesSent>2</bytesSent>
          <deviceIpAddress>String value</deviceIpAddress>
          <hreapLocallyAuthenticated>String value</hreapLocallyAuthenticated>
          <ipAddress>String value</ipAddress>
          <macAddress>String value</macAddress>
          <packetsReceived>2</packetsReceived>
          <packetsSent>2</packetsSent>
          <rssi>1</rssi>
          <snr>1</snr>
          <throughput>4.0</throughput>
          <traffic>2</traffic>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/ClientDetails/15.json

    {
      "queryResponse" : {
        "@type" : "ClientDetails",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/ClientDetails/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "clientDetailsDTO",
          "@type" : "ClientDetails",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/ClientDetails/15",
          "clientDetailsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "apName" : "String value",
            "apSlotId" : 1,
            "associationTime" : 2,
            "auditSessionId" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authnTimeStamp" : "String value",
            "authorizationPolicy" : "String value",
            "authorizedBy" : "String value",
            "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",
            "deviceName" : "String value",
            "deviceType" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "failureCode" : "String value",
            "failureStep" : "String value",
            "firstSeenTime" : 2,
            "hostname" : "String value",
            "ifDescr" : "String value",
            "ifIndex" : 1,
            "ipType" : "IPV4",
            "iseName" : "String value",
            "location" : "String value",
            "mobilityStatus" : "UNASSOCIATED",
            "nacState" : "NA",
            "policyType" : "DOT1X",
            "policyTypeStatus" : "IDLE",
            "postureStatus" : "UNKNOWN",
            "protocol" : "UNDEFINED",
            "radiusResponse" : "String value",
            "securityPolicyStatus" : "PASSED",
            "speed" : "UNKNOWN",
            "ssid" : "String value",
            "status" : "IDLE",
            "updateTime" : 2,
            "userName" : "String value",
            "vendor" : "String value",
            "vlanName" : "String value",
            "webSecurity" : "DISABLED",
            "wepState" : "NA",
            "wgbStatus" : "REGULARCLIENT",
            "wiredClientType" : "NA",
            "apIpAddress" : "String value",
            "apMacAddress" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "deviceIpAddress" : "String value",
            "hreapLocallyAuthenticated" : "String value",
            "ipAddress" : "String value",
            "macAddress" : "String value",
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "rssi" : 1,
            "snr" : 1,
            "throughput" : 4,
            "traffic" : 2,
            "vlan" : "String value",
            "wgbMacAddress" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/ClientDetails

Updated

This resource has been updated since the previous API version. It may have changes that are not compatible with API clients written for previous API versions.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
apIpAddress InetAddress | Associated AP IP address
apMacAddress String | Associated AP MAC address
apName String | Associated AP name
apSlotId int | Slot ID of the associated radio in the AP
associationTime long | Current or last session start time, measured in milliseconds since the Unix epoch.
auditSessionId String | Client audit session ID
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authnTimeStamp String | Authorization time stamp acquired from Cisco Identity Service Engine
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
authorizedBy String | Authorization provider
ccxFSVersion CcxFSVersionEnum | CCX FS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxLSVersion CcxFSVersionEnum | CCX LS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxMSVersion CcxFSVersionEnum | CCX MS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxVSVersion CcxFSVersionEnum | CCX VS version of teh client card Allowed values UNSUPPORTED NONE V1 V2
ccxVersion CCXVersionEnum | CCX version of the client card Allowed values UNSUPPORTED V1 V2 V3 V4 V5 V6
clientAaaOverrideAclApplied ClientAclAppliedEnum | Flag indicating whether AAA override ACL is applied to the client Allowed values YES NO NA
clientAaaOverrideAclName String | AAA override ACL name applied to the client
clientAclApplied ClientAclAppliedEnum | Flag indicating whether ACL applied to the client Allowed values YES NO NA
clientAclName String | ACL name applied to the client
clientApMode ClientApModeEnum | Client AP mode. The value UNKNOWN corresponds to the Sniffer mode. Allowed values LOCAL MONITOR HREAP ROGUEDETECTOR UNKNOWN BRIDGE SECONNECT FLEXPLUSBRIDGE REMOTEHYBRID SENSOR
clientInterface String | Client Interface
clientRedirectUrl String | Redirect URL applied to the client
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | Client CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress InetAddress | Associated device IP address
deviceName String | Associated device name (controller or switch)
deviceType String | Client device type identified and acquired from Cisco Identity Service Engine
eapType EapTypeEnum | EAP type Allowed values EAPTLS TTLS PEAP LEAP SPEKE EAPFAST NA UNNOWN MD5 EAPSIM
encryptionCypher EncryptionCypherEnum | Client encryption cypher Allowed values CCMPAES TKIPMIC LITERAL2 WEP140 WEP128 NONE NA UNKNOWN
failureCode String | Failure code acquired from Cisco Identity Service Engine
failureStep String | Failure step acquired from Cisco Identity Service Engine
firstSeenTime long | The time when the client was first discoved, measured in milliseconds since the Unix epoch.
hostname String | DNS reverse lookup from client IP address
hreapLocallyAuthenticated String | Flag indicating whether the client is authenticated via HREAP
ifDescr String | SNMP ifDescr if the switch that the client is connected to
ifIndex int | SNMP ifIndex of the switch that the client is connected to
ipAddress InetAddress | Client IP address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual-Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
iseName String | ISE (Cisco Identity Service Engine) name which the client is reported
location String | MAP location
macAddress String | Client MAC address
mobilityStatus MobilityStatusEnum | 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
policyType SecurityPolicyEnum | Security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
policyTypeStatus PolicyTypeStatusEnum | Client policy type status acquired from Cisco Identity Service Engine Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
protocol ClientProtocolEnum | Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3) Allowed values UNDEFINED DOT11A DOT11B DOT11G UNKNOWN MOBILE DOT11N2_4GNZ DOT11N5GHZ DOT3 DOT3GUEST DOT11AC DOT11AX5GHZ DOT11AX2_4GHZ
radiusResponse String | Radius server response acquired from Cisco Identity Service Engine
securityPolicyStatus SecurityPolicyStatusEnum | Status whether the client is on network (in running state) Allowed values PASSED FAILED
speed ClientSpeedEnum | The port speed that the client is connected to. For wireless clients the value of this attribute is UNKNOWN. Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
ssid String | SSID
status ClientStatusEnum | Status of the client connection Allowed values IDLE AUTHPENDING AUTHENTICATED ASSOCIATED POWERSAVE DISASSOCIATED TOBEDELETED PROBING BLACKLISTED NOTCONFIGURED UNAUTHENTICATED
updateTime long | Last time this record was updated, measured in milliseconds since the Unix epoch.
userName String | Client username
vendor String | Vendor name of the client card derived from OUI mapping. Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
vlan String | ID of the vlan the client is connected to
vlanName String | Name of the vlan the client is connected to
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wepState WepStateEnum | Client WEP state Allowed values NA ENABLED DISABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | 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

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://10.64.88.203/webacs/api/v2/data/ClientDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/ClientDetails/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="clientDetailsDTO" type="ClientDetails" url="https://10.64.88.203/webacs/api/v2/data/ClientDetails/15">
        <clientDetailsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <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>
          <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>
          <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>
          <ifDescr>String value</ifDescr>
          <ifIndex>1</ifIndex>
          <ipType>IPV4</ipType>
          <iseName>String value</iseName>
          <location>String value</location>
          <mobilityStatus>UNASSOCIATED</mobilityStatus>
          <nacState>NA</nacState>
          <policyType>DOT1X</policyType>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <postureStatus>UNKNOWN</postureStatus>
          <protocol>UNDEFINED</protocol>
          <radiusResponse>String value</radiusResponse>
          <securityPolicyStatus>PASSED</securityPolicyStatus>
          <speed>UNKNOWN</speed>
          <ssid>String value</ssid>
          <status>IDLE</status>
          <updateTime>2</updateTime>
          <userName>String value</userName>
          <vendor>String value</vendor>
          <vlanName>String value</vlanName>
          <webSecurity>DISABLED</webSecurity>
          <wepState>NA</wepState>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <wiredClientType>NA</wiredClientType>
          <apIpAddress>
            <address>192.168.115.243</address>
          </apIpAddress>
          <apMacAddress>String value</apMacAddress>
          <deviceIpAddress>
            <address>192.168.115.243</address>
          </deviceIpAddress>
          <hreapLocallyAuthenticated>String value</hreapLocallyAuthenticated>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <macAddress>String value</macAddress>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/ClientDetails/15.json

    {
      "queryResponse" : {
        "@type" : "ClientDetails",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/ClientDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "clientDetailsDTO",
          "@type" : "ClientDetails",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/ClientDetails/15",
          "clientDetailsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "apIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apMacAddress" : "String value",
            "apName" : "String value",
            "apSlotId" : 1,
            "associationTime" : 2,
            "auditSessionId" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authnTimeStamp" : "String value",
            "authorizationPolicy" : "String value",
            "authorizedBy" : "String value",
            "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" : {
              "address" : "192.168.115.243"
            },
            "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" : {
              "address" : "192.168.115.243"
            },
            "ipType" : "IPV4",
            "iseName" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "mobilityStatus" : "UNASSOCIATED",
            "nacState" : "NA",
            "policyType" : "DOT1X",
            "policyTypeStatus" : "IDLE",
            "postureStatus" : "UNKNOWN",
            "protocol" : "UNDEFINED",
            "radiusResponse" : "String value",
            "securityPolicyStatus" : "PASSED",
            "speed" : "UNKNOWN",
            "ssid" : "String value",
            "status" : "IDLE",
            "updateTime" : 2,
            "userName" : "String value",
            "vendor" : "String value",
            "vlan" : "String value",
            "vlanName" : "String value",
            "webSecurity" : "DISABLED",
            "wepState" : "NA",
            "wgbMacAddress" : "String value",
            "wgbStatus" : "REGULARCLIENT",
            "wiredClientType" : "NA"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/ClientDetails

Unmodified

This resource has not been modified since the previous API version.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
apIpAddress InetAddress | Associated AP IP address
apMacAddress String | Associated AP MAC address
apName String | Associated AP name
apSlotId int | Slot ID of the associated radio in the AP
associationTime long | Current or last session start time, measured in milliseconds since the Unix epoch.
auditSessionId String | Client audit session ID
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authnTimeStamp String | Authorization time stamp acquired from Cisco Identity Service Engine
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
authorizedBy String | Authorization provider
ccxFSVersion CcxFSVersionEnum | CCX FS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxLSVersion CcxFSVersionEnum | CCX LS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxMSVersion CcxFSVersionEnum | CCX MS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxVSVersion CcxFSVersionEnum | CCX VS version of teh client card Allowed values UNSUPPORTED NONE V1 V2
ccxVersion CCXVersionEnum | CCX version of the client card Allowed values UNSUPPORTED V1 V2 V3 V4 V5 V6
clientAaaOverrideAclApplied ClientAclAppliedEnum | Flag indicating whether AAA override ACL is applied to the client Allowed values YES NO NA
clientAaaOverrideAclName String | AAA override ACL name applied to the client
clientAclApplied ClientAclAppliedEnum | Flag indicating whether ACL applied to the client Allowed values YES NO NA
clientAclName String | ACL name applied to the client
clientApMode ClientApModeEnum | Client AP mode. The value UNKNOWN corresponds to the Sniffer mode. Allowed values LOCAL MONITOR HREAP ROGUEDETECTOR UNKNOWN BRIDGE SECONNECT FLEXPLUSBRIDGE REMOTEHYBRID SENSOR
clientInterface String | Client Interface
clientRedirectUrl String | Redirect URL applied to the client
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | Client CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress InetAddress | Associated device IP address
deviceName String | Associated device name (controller or switch)
deviceType String | Client device type identified and acquired from Cisco Identity Service Engine
eapType EapTypeEnum | EAP type Allowed values EAPTLS TTLS PEAP LEAP SPEKE EAPFAST NA UNNOWN MD5 EAPSIM
encryptionCypher EncryptionCypherEnum | Client encryption cypher Allowed values CCMPAES TKIPMIC LITERAL2 WEP140 WEP128 NONE NA UNKNOWN
failureCode String | Failure code acquired from Cisco Identity Service Engine
failureStep String | Failure step acquired from Cisco Identity Service Engine
firstSeenTime long | The time when the client was first discoved, measured in milliseconds since the Unix epoch.
hostname String | DNS reverse lookup from client IP address
hreapLocallyAuthenticated String | Flag indicating whether the client is authenticated via HREAP
ifDescr String | SNMP ifDescr if the switch that the client is connected to
ifIndex int | SNMP ifIndex of the switch that the client is connected to
ipAddress InetAddress | Client IP address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual-Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
iseName String | ISE (Cisco Identity Service Engine) name which the client is reported
location String | MAP location
macAddress String | Client MAC address
mobilityStatus MobilityStatusEnum | 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
policyType SecurityPolicyEnum | Security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
policyTypeStatus PolicyTypeStatusEnum | Client policy type status acquired from Cisco Identity Service Engine Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
protocol ClientProtocolEnum | Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3) Allowed values UNDEFINED DOT11A DOT11B DOT11G UNKNOWN MOBILE DOT11N2_4GNZ DOT11N5GHZ DOT3 DOT3GUEST DOT11AC DOT11AX5GHZ DOT11AX2_4GHZ
radiusResponse String | Radius server response acquired from Cisco Identity Service Engine
securityPolicyStatus SecurityPolicyStatusEnum | Status whether the client is on network (in running state) Allowed values PASSED FAILED
speed ClientSpeedEnum | The port speed that the client is connected to. For wireless clients the value of this attribute is UNKNOWN. Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
ssid String | SSID
status ClientStatusEnum | Status of the client connection Allowed values IDLE AUTHPENDING AUTHENTICATED ASSOCIATED POWERSAVE DISASSOCIATED TOBEDELETED PROBING BLACKLISTED NOTCONFIGURED UNAUTHENTICATED
updateTime long | Last time this record was updated, measured in milliseconds since the Unix epoch.
userName String | Client username
vendor String | Vendor name of the client card derived from OUI mapping. Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
vlan String | ID of the vlan the client is connected to
vlanName String | Name of the vlan the client is connected to
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wepState WepStateEnum | Client WEP state Allowed values NA ENABLED DISABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | 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

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://10.64.88.203/webacs/api/v3/data/ClientDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/ClientDetails/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="clientDetailsDTO" type="ClientDetails" url="https://10.64.88.203/webacs/api/v3/data/ClientDetails/15">
        <clientDetailsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <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>
          <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>
          <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>
          <ifDescr>String value</ifDescr>
          <ifIndex>1</ifIndex>
          <ipType>IPV4</ipType>
          <iseName>String value</iseName>
          <location>String value</location>
          <mobilityStatus>UNASSOCIATED</mobilityStatus>
          <nacState>NA</nacState>
          <policyType>DOT1X</policyType>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <postureStatus>UNKNOWN</postureStatus>
          <protocol>UNDEFINED</protocol>
          <radiusResponse>String value</radiusResponse>
          <securityPolicyStatus>PASSED</securityPolicyStatus>
          <speed>UNKNOWN</speed>
          <ssid>String value</ssid>
          <status>IDLE</status>
          <updateTime>2</updateTime>
          <userName>String value</userName>
          <vendor>String value</vendor>
          <vlanName>String value</vlanName>
          <webSecurity>DISABLED</webSecurity>
          <wepState>NA</wepState>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <wiredClientType>NA</wiredClientType>
          <apIpAddress>
            <address>192.168.115.243</address>
          </apIpAddress>
          <apMacAddress>String value</apMacAddress>
          <deviceIpAddress>
            <address>192.168.115.243</address>
          </deviceIpAddress>
          <hreapLocallyAuthenticated>String value</hreapLocallyAuthenticated>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <macAddress>String value</macAddress>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/ClientDetails/15.json

    {
      "queryResponse" : {
        "@type" : "ClientDetails",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/ClientDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "clientDetailsDTO",
          "@type" : "ClientDetails",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/ClientDetails/15",
          "clientDetailsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "apIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apMacAddress" : "String value",
            "apName" : "String value",
            "apSlotId" : 1,
            "associationTime" : 2,
            "auditSessionId" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authnTimeStamp" : "String value",
            "authorizationPolicy" : "String value",
            "authorizedBy" : "String value",
            "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" : {
              "address" : "192.168.115.243"
            },
            "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" : {
              "address" : "192.168.115.243"
            },
            "ipType" : "IPV4",
            "iseName" : "String value",
            "location" : "String value",
            "macAddress" : "String value",
            "mobilityStatus" : "UNASSOCIATED",
            "nacState" : "NA",
            "policyType" : "DOT1X",
            "policyTypeStatus" : "IDLE",
            "postureStatus" : "UNKNOWN",
            "protocol" : "UNDEFINED",
            "radiusResponse" : "String value",
            "securityPolicyStatus" : "PASSED",
            "speed" : "UNKNOWN",
            "ssid" : "String value",
            "status" : "IDLE",
            "updateTime" : 2,
            "userName" : "String value",
            "vendor" : "String value",
            "vlan" : "String value",
            "vlanName" : "String value",
            "webSecurity" : "DISABLED",
            "wepState" : "NA",
            "wgbMacAddress" : "String value",
            "wgbStatus" : "REGULARCLIENT",
            "wiredClientType" : "NA"
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/ClientDetails

Updated

Since version 4 type of macAddress, apMacAddress, and wgbMacAddress attributes is MacAddress. Type of vlan attribute has been changed to int, type of hreapLocallyAuthenticated attribute changed to enum.

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
apIpAddress InetAddress | Associated AP IP address
apMacAddress MacAddress | Associated AP MAC address
apName String | Associated AP name
apSlotId int | Slot ID of the associated radio in the AP
associationTime long | Current or last session start time, measured in milliseconds since the Unix epoch.
auditSessionId String | Client audit session ID
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authnTimeStamp String | Authorization time stamp acquired from Cisco Identity Service Engine
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
authorizedBy String | Authorization provider
ccxFSVersion CcxFSVersionEnum | CCX FS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxLSVersion CcxFSVersionEnum | CCX LS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxMSVersion CcxFSVersionEnum | CCX MS version of the client card Allowed values UNSUPPORTED NONE V1 V2
ccxVSVersion CcxFSVersionEnum | CCX VS version of teh client card Allowed values UNSUPPORTED NONE V1 V2
ccxVersion CCXVersionEnum | CCX version of the client card Allowed values UNSUPPORTED V1 V2 V3 V4 V5 V6
clientAaaOverrideAclApplied ClientAclAppliedEnum | Flag indicating whether AAA override ACL is applied to the client Allowed values YES NO NA
clientAaaOverrideAclName String | AAA override ACL name applied to the client
clientAclApplied ClientAclAppliedEnum | Flag indicating whether ACL applied to the client Allowed values YES NO NA
clientAclName String | ACL name applied to the client
clientAddresses ClientAddress[] | List of Client IPv6 Addresses
Attribute | Description
--- | ---
assignmentType ClientIpAddressAssignmentType | Assignment type Allowed values DHCPV6 SELF_ASSIGNED SLAAC_OR_STATIC UNKNOWN
discoverTime Date | Client discovery time
ipAddress InetAddress | IP address
ipAddressScope ClientIpAddressScope | IP address scope Allowed values DHCPV6 SELF_ASSIGNED SLAAC_OR_STATIC
macAddress MacAddress | Client MAC address
clientApMode ClientApModeEnum | Client AP mode. The value UNKNOWN corresponds to the Sniffer mode. Allowed values LOCAL MONITOR HREAP ROGUEDETECTOR UNKNOWN BRIDGE SECONNECT FLEXPLUSBRIDGE REMOTEHYBRID SENSOR
clientInterface String | Client Interface
clientRedirectUrl String | Redirect URL applied to the client
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | Client CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress InetAddress | Associated device IP address
deviceName String | Associated device name (controller or switch)
deviceType String | Client device type identified and acquired from Cisco Identity Service Engine
eapType EapTypeEnum | EAP type Allowed values EAPTLS TTLS PEAP LEAP SPEKE EAPFAST NA UNNOWN MD5 EAPSIM
encryptionCypher EncryptionCypherEnum | Client encryption cypher Allowed values CCMPAES TKIPMIC LITERAL2 WEP140 WEP128 NONE NA UNKNOWN
failureCode String | Failure code acquired from Cisco Identity Service Engine
failureStep String | Failure step acquired from Cisco Identity Service Engine
firstSeenTime long | The time when the client was first discoved, measured in milliseconds since the Unix epoch.
hostname String | DNS reverse lookup from client IP address
hreapLocallyAuthenticated HreapAuthenticationEnum | Flag indicating whether the client is authenticated via HREAP Allowed values YES NO NA
ifDescr String | SNMP ifDescr if the switch that the client is connected to
ifIndex int | SNMP ifIndex of the switch that the client is connected to
ipAddress InetAddress | Client IP address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual-Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
iseName String | ISE (Cisco Identity Service Engine) name which the client is reported
location String | MAP location
macAddress MacAddress | Client MAC address
mobilityStatus MobilityStatusEnum | 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
policyType SecurityPolicyEnum | Security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
policyTypeStatus PolicyTypeStatusEnum | Client policy type status acquired from Cisco Identity Service Engine Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
protocol ClientProtocolEnum | Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3) Allowed values UNDEFINED DOT11A DOT11B DOT11G UNKNOWN MOBILE DOT11N2_4GNZ DOT11N5GHZ DOT3 DOT3GUEST DOT11AC DOT11AX5GHZ DOT11AX2_4GHZ
radiusResponse String | Radius server response acquired from Cisco Identity Service Engine
securityPolicyStatus SecurityPolicyStatusEnum | Status whether the client is on network (in running state) Allowed values PASSED FAILED
speed ClientSpeedEnum | The port speed that the client is connected to. For wireless clients the value of this attribute is UNKNOWN. Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
ssid String | SSID
status ClientStatusEnum | Status of the client connection Allowed values IDLE AUTHPENDING AUTHENTICATED ASSOCIATED POWERSAVE DISASSOCIATED TOBEDELETED PROBING BLACKLISTED NOTCONFIGURED UNAUTHENTICATED
updateTime long | Last time this record was updated, measured in milliseconds since the Unix epoch.
userName String | Client username
vendor String | Vendor name of the client card derived from OUI mapping. Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
vlan int | ID of the vlan the client is connected to
vlanName String | Name of the vlan the client is connected to
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wepState WepStateEnum | Client WEP state Allowed values NA ENABLED DISABLED
wgbMacAddress MacAddress | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | 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

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://10.64.88.203/webacs/api/v4/data/ClientDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/ClientDetails/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="clientDetailsDTO" type="ClientDetails" url="https://10.64.88.203/webacs/api/v4/data/ClientDetails/15">
        <clientDetailsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <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>
          <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>
          <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>
          <ifDescr>String value</ifDescr>
          <ifIndex>1</ifIndex>
          <ipType>IPV4</ipType>
          <iseName>String value</iseName>
          <location>String value</location>
          <mobilityStatus>UNASSOCIATED</mobilityStatus>
          <nacState>NA</nacState>
          <policyType>DOT1X</policyType>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <postureStatus>UNKNOWN</postureStatus>
          <protocol>UNDEFINED</protocol>
          <radiusResponse>String value</radiusResponse>
          <securityPolicyStatus>PASSED</securityPolicyStatus>
          <speed>UNKNOWN</speed>
          <ssid>String value</ssid>
          <status>IDLE</status>
          <updateTime>2</updateTime>
          <userName>String value</userName>
          <vendor>String value</vendor>
          <vlanName>String value</vlanName>
          <webSecurity>DISABLED</webSecurity>
          <wepState>NA</wepState>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <wiredClientType>NA</wiredClientType>
          <apIpAddress>
            <address>192.168.115.243</address>
          </apIpAddress>
          <apMacAddress>
            <octets>000a959d6816</octets>
          </apMacAddress>
          <clientAddresses>
            <clientAddress>
              <assignmentType>DHCPV6</assignmentType>
              <discoverTime>1986-07-24T00:00:00+05:30</discoverTime>
              <ipAddress>
                <address>192.168.115.243</address>
              </ipAddress>
              <ipAddressScope>DHCPV6</ipAddressScope>
              <macAddress>
                <octets>000a959d6816</octets>
              </macAddress>
            </clientAddress>
            <clientAddress>
              <assignmentType>SELF_ASSIGNED</assignmentType>
              <discoverTime>1991-01-11T00:00:00+05:30</discoverTime>
              <ipAddress>
                <address>192.168.115.244</address>
              </ipAddress>
              <ipAddressScope>SELF_ASSIGNED</ipAddressScope>
              <macAddress>
                <octets>000a959d6817</octets>
              </macAddress>
            </clientAddress>
          </clientAddresses>
          <deviceIpAddress>
            <address>192.168.115.243</address>
          </deviceIpAddress>
          <hreapLocallyAuthenticated>YES</hreapLocallyAuthenticated>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <vlan>1</vlan>
          <wgbMacAddress>
            <octets>000a959d6816</octets>
          </wgbMacAddress>
        </clientDetailsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/ClientDetails/15.json

    {
      "queryResponse" : {
        "@type" : "ClientDetails",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/ClientDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "clientDetailsDTO",
          "@type" : "ClientDetails",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/ClientDetails/15",
          "clientDetailsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "apIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apMacAddress" : {
              "octets" : "000a959d6816"
            },
            "apName" : "String value",
            "apSlotId" : 1,
            "associationTime" : 2,
            "auditSessionId" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authnTimeStamp" : "String value",
            "authorizationPolicy" : "String value",
            "authorizedBy" : "String value",
            "ccxFSVersion" : "UNSUPPORTED",
            "ccxLSVersion" : "UNSUPPORTED",
            "ccxMSVersion" : "UNSUPPORTED",
            "ccxVSVersion" : "UNSUPPORTED",
            "ccxVersion" : "UNSUPPORTED",
            "clientAaaOverrideAclApplied" : "YES",
            "clientAaaOverrideAclName" : "String value",
            "clientAclApplied" : "YES",
            "clientAclName" : "String value",
            "clientAddresses" : {
              "clientAddress" : [ {
                "assignmentType" : "DHCPV6",
                "discoverTime" : "1986-07-23T18:30:00.000Z",
                "ipAddress" : {
                  "address" : "192.168.115.243"
                },
                "ipAddressScope" : "DHCPV6",
                "macAddress" : {
                  "octets" : "000a959d6816"
                }
              }, {
                "assignmentType" : "SELF_ASSIGNED",
                "discoverTime" : "1991-01-10T18:30:00.000Z",
                "ipAddress" : {
                  "address" : "192.168.115.244"
                },
                "ipAddressScope" : "SELF_ASSIGNED",
                "macAddress" : {
                  "octets" : "000a959d6817"
                }
              } ]
            },
            "clientApMode" : "LOCAL",
            "clientInterface" : "String value",
            "clientRedirectUrl" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceIpAddress" : {
              "address" : "192.168.115.243"
            },
            "deviceName" : "String value",
            "deviceType" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "failureCode" : "String value",
            "failureStep" : "String value",
            "firstSeenTime" : 2,
            "hostname" : "String value",
            "hreapLocallyAuthenticated" : "YES",
            "ifDescr" : "String value",
            "ifIndex" : 1,
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "ipType" : "IPV4",
            "iseName" : "String value",
            "location" : "String value",
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "mobilityStatus" : "UNASSOCIATED",
            "nacState" : "NA",
            "policyType" : "DOT1X",
            "policyTypeStatus" : "IDLE",
            "postureStatus" : "UNKNOWN",
            "protocol" : "UNDEFINED",
            "radiusResponse" : "String value",
            "securityPolicyStatus" : "PASSED",
            "speed" : "UNKNOWN",
            "ssid" : "String value",
            "status" : "IDLE",
            "updateTime" : 2,
            "userName" : "String value",
            "vendor" : "String value",
            "vlan" : 1,
            "vlanName" : "String value",
            "webSecurity" : "DISABLED",
            "wepState" : "NA",
            "wgbMacAddress" : {
              "octets" : "000a959d6816"
            },
            "wgbStatus" : "REGULARCLIENT",
            "wiredClientType" : "NA"
          }
        } ]
      }
    }