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

# GET ClientSessions

Represents detail view of client sessions. It provides device and session related attributes including security, connected device, session time, traffic, etc.

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? | No
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/ClientSessions

Deprecated

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

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
anchorIpAddress String | IP address of the mobility anchor controller if any
apIpAddress String | Associated AP IP address
apMacAddress String | Associated AP MAC address
apName String | Associated AP name
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
bytesReceived long | Number of bytes received during the session
bytesSent long | Number of bytes sent during the session
clientInterface String | Client Interface
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress String | Associated device IP address
deviceName String | Associated device name (controller or switch)
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
ipAddress String | Client IP Address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
location String | Associated AP or switch Map location
macAddress String | Client MAC Address
packetsReceived long | Number of packets received during the session
packetsSent long | Number of bytes sent during the session
policyTypeStatus PolicyTypeStatusEnum | Client policy status Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
portSpeed ClientSpeedEnum | Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps) for wired client Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
profileName String | Profile name
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
roamReason String | The reason reported from controller why client is moved to another AP
rssi int | RSSI observed from last polling during the session
securityPolicy SecurityPolicyEnum | Client security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
sessionEndTime long | Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100).
sessionStartTime long | Session start time is the time the session started, measured in milliseconds since the Unix epoch.
snr int | SNR (Signal to Noise Ratio) observed from last polling during the session
ssid String | SSID
throughput double | Average session throughput
userName String | Client Username
vlan String | Vlan name
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | Flag to indicate whether the client is WGB client, WGB AP or local client Allowed values REGULARCLIENT WGBCLIENT WGBAP

## 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/ClientSessions/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientSessions" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/ClientSessions/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="clientSessionsDTO" type="ClientSessions" url="https://10.64.88.203/webacs/api/v1/data/ClientSessions/15">
        <clientSessionsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
          <authorizationPolicy>String value</authorizationPolicy>
          <bytesReceived>2</bytesReceived>
          <bytesSent>2</bytesSent>
          <clientInterface>String value</clientInterface>
          <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
          <ctsSecurityGroup>String value</ctsSecurityGroup>
          <deviceName>String value</deviceName>
          <eapType>EAPTLS</eapType>
          <encryptionCypher>CCMPAES</encryptionCypher>
          <ipType>IPV4</ipType>
          <location>String value</location>
          <packetsReceived>2</packetsReceived>
          <packetsSent>2</packetsSent>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <portSpeed>UNKNOWN</portSpeed>
          <postureStatus>UNKNOWN</postureStatus>
          <profileName>String value</profileName>
          <protocol>UNDEFINED</protocol>
          <roamReason>String value</roamReason>
          <rssi>1</rssi>
          <securityPolicy>DOT1X</securityPolicy>
          <sessionEndTime>2</sessionEndTime>
          <sessionStartTime>2</sessionStartTime>
          <snr>1</snr>
          <ssid>String value</ssid>
          <throughput>4.0</throughput>
          <userName>String value</userName>
          <webSecurity>DISABLED</webSecurity>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <anchorIpAddress>String value</anchorIpAddress>
          <apIpAddress>String value</apIpAddress>
          <apMacAddress>String value</apMacAddress>
          <apName>String value</apName>
          <deviceIpAddress>String value</deviceIpAddress>
          <ipAddress>String value</ipAddress>
          <macAddress>String value</macAddress>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientSessionsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "ClientSessions",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/ClientSessions/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "clientSessionsDTO",
          "@type" : "ClientSessions",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/ClientSessions/15",
          "clientSessionsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authorizationPolicy" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "clientInterface" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceName" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "ipType" : "IPV4",
            "location" : "String value",
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "policyTypeStatus" : "IDLE",
            "portSpeed" : "UNKNOWN",
            "postureStatus" : "UNKNOWN",
            "profileName" : "String value",
            "protocol" : "UNDEFINED",
            "roamReason" : "String value",
            "rssi" : 1,
            "securityPolicy" : "DOT1X",
            "sessionEndTime" : 2,
            "sessionStartTime" : 2,
            "snr" : 1,
            "ssid" : "String value",
            "throughput" : 4,
            "userName" : "String value",
            "webSecurity" : "DISABLED",
            "wgbStatus" : "REGULARCLIENT",
            "anchorIpAddress" : "String value",
            "apIpAddress" : "String value",
            "apMacAddress" : "String value",
            "apName" : "String value",
            "deviceIpAddress" : "String value",
            "ipAddress" : "String value",
            "macAddress" : "String value",
            "vlan" : "String value",
            "wgbMacAddress" : "String value"
          }
        }
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v2/data/ClientSessions

Unmodified

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

Deprecated

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

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
anchorIpAddress String | IP address of the mobility anchor controller if any
apIpAddress String | Associated AP IP address
apMacAddress String | Associated AP MAC address
apName String | Associated AP name
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
bytesReceived long | Number of bytes received during the session
bytesSent long | Number of bytes sent during the session
clientInterface String | Client Interface
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | CTS security group acquired from Cisco Identity Service Engine
deviceIpAddress String | Associated device IP address
deviceName String | Associated device name (controller or switch)
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
ipAddress String | Client IP Address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
location String | Associated AP or switch Map location
macAddress String | Client MAC Address
packetsReceived long | Number of packets received during the session
packetsSent long | Number of bytes sent during the session
policyTypeStatus PolicyTypeStatusEnum | Client policy status Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
portSpeed ClientSpeedEnum | Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps) for wired client Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
profileName String | Profile name
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
roamReason String | The reason reported from controller why client is moved to another AP
rssi int | RSSI observed from last polling during the session
securityPolicy SecurityPolicyEnum | Client security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
sessionEndTime long | Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100).
sessionStartTime long | Session start time is the time the session started, measured in milliseconds since the Unix epoch.
snr int | SNR (Signal to Noise Ratio) observed from last polling during the session
ssid String | SSID
throughput double | Average session throughput
userName String | Client Username
vlan String | Vlan name
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | Flag to indicate whether the client is WGB client, WGB AP or local client Allowed values REGULARCLIENT WGBCLIENT WGBAP

## 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/ClientSessions/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientSessions" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/ClientSessions/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="clientSessionsDTO" type="ClientSessions" url="https://10.64.88.203/webacs/api/v2/data/ClientSessions/15">
        <clientSessionsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
          <authorizationPolicy>String value</authorizationPolicy>
          <bytesReceived>2</bytesReceived>
          <bytesSent>2</bytesSent>
          <clientInterface>String value</clientInterface>
          <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
          <ctsSecurityGroup>String value</ctsSecurityGroup>
          <deviceName>String value</deviceName>
          <eapType>EAPTLS</eapType>
          <encryptionCypher>CCMPAES</encryptionCypher>
          <ipType>IPV4</ipType>
          <location>String value</location>
          <packetsReceived>2</packetsReceived>
          <packetsSent>2</packetsSent>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <portSpeed>UNKNOWN</portSpeed>
          <postureStatus>UNKNOWN</postureStatus>
          <profileName>String value</profileName>
          <protocol>UNDEFINED</protocol>
          <roamReason>String value</roamReason>
          <rssi>1</rssi>
          <securityPolicy>DOT1X</securityPolicy>
          <sessionEndTime>2</sessionEndTime>
          <sessionStartTime>2</sessionStartTime>
          <snr>1</snr>
          <ssid>String value</ssid>
          <throughput>4.0</throughput>
          <userName>String value</userName>
          <webSecurity>DISABLED</webSecurity>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <anchorIpAddress>String value</anchorIpAddress>
          <apIpAddress>String value</apIpAddress>
          <apMacAddress>String value</apMacAddress>
          <apName>String value</apName>
          <deviceIpAddress>String value</deviceIpAddress>
          <ipAddress>String value</ipAddress>
          <macAddress>String value</macAddress>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientSessionsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "ClientSessions",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/ClientSessions/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "clientSessionsDTO",
          "@type" : "ClientSessions",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/ClientSessions/15",
          "clientSessionsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "anchorIpAddress" : "String value",
            "apIpAddress" : "String value",
            "apMacAddress" : "String value",
            "apName" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authorizationPolicy" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "clientInterface" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceIpAddress" : "String value",
            "deviceName" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "ipAddress" : "String value",
            "ipType" : "IPV4",
            "location" : "String value",
            "macAddress" : "String value",
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "policyTypeStatus" : "IDLE",
            "portSpeed" : "UNKNOWN",
            "postureStatus" : "UNKNOWN",
            "profileName" : "String value",
            "protocol" : "UNDEFINED",
            "roamReason" : "String value",
            "rssi" : 1,
            "securityPolicy" : "DOT1X",
            "sessionEndTime" : 2,
            "sessionStartTime" : 2,
            "snr" : 1,
            "ssid" : "String value",
            "throughput" : 4.0,
            "userName" : "String value",
            "vlan" : "String value",
            "webSecurity" : "DISABLED",
            "wgbMacAddress" : "String value",
            "wgbStatus" : "REGULARCLIENT"
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v3/data/ClientSessions

Updated

Since version 3 this API does not contain associated AP name and IP address to improve performance.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
anchorIpAddress InetAddress | IP address of the mobility anchor controller if any
apMacAddress String | Associated AP MAC address
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
bytesReceived long | Number of bytes received during the session
bytesSent long | Number of bytes sent during the session
clientInterface String | Client Interface
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | CTS security group acquired from Cisco Identity Service Engine
deviceMgmtAddress InetAddress | Associated device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
deviceName String | Associated device name (controller or switch)
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
ipAddress InetAddress | Client IP Address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
location String | Associated AP or switch Map location
macAddress String | Client MAC Address
packetsReceived long | Number of packets received during the session
packetsSent long | Number of bytes sent during the session
policyTypeStatus PolicyTypeStatusEnum | Client policy status Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
portSpeed ClientSpeedEnum | Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps) for wired client Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
profileName String | Profile name
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
roamReason String | The reason reported from controller why client is moved to another AP
rssi int | RSSI observed from last polling during the session
securityPolicy SecurityPolicyEnum | Client security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
sessionEndTime long | Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100).
sessionStartTime long | Session start time is the time the session started, measured in milliseconds since the Unix epoch.
snr int | SNR (Signal to Noise Ratio) observed from last polling during the session
ssid String | SSID
throughput double | Average session throughput
userName String | Client Username
vlan String | Vlan name
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wgbMacAddress String | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | Flag to indicate whether the client is WGB client, WGB AP or local client Allowed values REGULARCLIENT WGBCLIENT WGBAP

## 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/ClientSessions/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientSessions" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/ClientSessions/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="clientSessionsDTO" type="ClientSessions" url="https://10.64.88.203/webacs/api/v3/data/ClientSessions/15">
        <clientSessionsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
          <authorizationPolicy>String value</authorizationPolicy>
          <bytesReceived>2</bytesReceived>
          <bytesSent>2</bytesSent>
          <clientInterface>String value</clientInterface>
          <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
          <ctsSecurityGroup>String value</ctsSecurityGroup>
          <deviceName>String value</deviceName>
          <eapType>EAPTLS</eapType>
          <encryptionCypher>CCMPAES</encryptionCypher>
          <ipType>IPV4</ipType>
          <location>String value</location>
          <packetsReceived>2</packetsReceived>
          <packetsSent>2</packetsSent>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <portSpeed>UNKNOWN</portSpeed>
          <postureStatus>UNKNOWN</postureStatus>
          <profileName>String value</profileName>
          <protocol>UNDEFINED</protocol>
          <roamReason>String value</roamReason>
          <rssi>1</rssi>
          <securityPolicy>DOT1X</securityPolicy>
          <sessionEndTime>2</sessionEndTime>
          <sessionStartTime>2</sessionStartTime>
          <snr>1</snr>
          <ssid>String value</ssid>
          <throughput>4.0</throughput>
          <userName>String value</userName>
          <webSecurity>DISABLED</webSecurity>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <anchorIpAddress>
            <address>192.168.115.243</address>
          </anchorIpAddress>
          <apMacAddress>String value</apMacAddress>
          <deviceMgmtAddress>
            <address>192.168.115.243</address>
          </deviceMgmtAddress>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <macAddress>String value</macAddress>
          <vlan>String value</vlan>
          <wgbMacAddress>String value</wgbMacAddress>
        </clientSessionsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "ClientSessions",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/ClientSessions/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "clientSessionsDTO",
          "@type" : "ClientSessions",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/ClientSessions/15",
          "clientSessionsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "anchorIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apMacAddress" : "String value",
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authorizationPolicy" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "clientInterface" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceMgmtAddress" : {
              "address" : "192.168.115.243"
            },
            "deviceName" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "ipType" : "IPV4",
            "location" : "String value",
            "macAddress" : "String value",
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "policyTypeStatus" : "IDLE",
            "portSpeed" : "UNKNOWN",
            "postureStatus" : "UNKNOWN",
            "profileName" : "String value",
            "protocol" : "UNDEFINED",
            "roamReason" : "String value",
            "rssi" : 1,
            "securityPolicy" : "DOT1X",
            "sessionEndTime" : 2,
            "sessionStartTime" : 2,
            "snr" : 1,
            "ssid" : "String value",
            "throughput" : 4.0,
            "userName" : "String value",
            "vlan" : "String value",
            "webSecurity" : "DISABLED",
            "wgbMacAddress" : "String value",
            "wgbStatus" : "REGULARCLIENT"
          }
        } ]
      }
    }

### Resource Information

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

## Resource URL

/webacs/api/v4/data/ClientSessions

Updated

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

## Response Parameters

Attribute | Description
--- | ---
adDomainName String | AD domain name acquired from Cisco Identity Service Engine
anchorIpAddress InetAddress | IP address of the mobility anchor controller if any
apMacAddress MacAddress | Associated AP MAC address
authenticationAlgorithm AuthenticationAlgorithmEnum | Client authentication algorithm Allowed values OPENSYSTEM SHAREDKEY UNKNOW OPENANDEAP
authorizationPolicy String | Authorization Policy acquired from Cisco Identity Service Engine
bytesReceived long | Number of bytes received during the session
bytesSent long | Number of bytes sent during the session
clientInterface String | Client Interface
connectionType ConnectionTypeEnum | Type of connection (Lightweight AP, Autonomous AP, or Wired) Allowed values LIGHTWEIGHTWIRELESS AUTONOMOUSWIRELESS WIRED
ctsSecurityGroup String | CTS security group acquired from Cisco Identity Service Engine
deviceMgmtAddress InetAddress | Associated device management address. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
deviceName String | Associated device name (controller or switch)
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
ipAddress InetAddress | Client IP Address
ipType ClientIpTypeEnum | Client IP type (IPv4, IPv6 or Dual Stack) Allowed values IPV4 IPV6 DUALSTACK NOTDETECTED
location String | Associated AP or switch Map location
macAddress MacAddress | Client MAC Address
packetsReceived long | Number of packets received during the session
packetsSent long | Number of bytes sent during the session
policyTypeStatus PolicyTypeStatusEnum | Client policy status Allowed values IDLE RUNNING NOMETHOD AUTHENTICATIONSUCEEDED AUTHENTICATIONFAILED AUTHORIZATIONSUCCEEDED AUTHORIZATIONFAILED DISASSOCIATED
portSpeed ClientSpeedEnum | Port speed (10Mbps, 100Mbps, 1Gbps, 10Gbps) for wired client Allowed values UNKNOWN SPEED10M SPEED100M SPEED1G SPEED10G
postureStatus PostureStatusEnum | Client posture status acquired from Cisco Identity Service Engine Allowed values UNKNOWN COMPLIANT NONCOMPLIANT PENDING NA ERROR
profileName String | Profile name
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
roamReason String | The reason reported from controller why client is moved to another AP
rssi int | RSSI observed from last polling during the session
securityPolicy SecurityPolicyEnum | Client security policy type Allowed values DOT1X WPA1 WPA2 WPA2VFF NA UNKNOWN CCKM MACAUTHBYPASS WEBAUTH WPA
sessionEndTime long | Session end time is the time the session finished, measured in milliseconds since the Unix epoch. For sessions that are still active, this time may be some point for in the future (for example Jan 1, 2100).
sessionStartTime long | Session start time is the time the session started, measured in milliseconds since the Unix epoch.
snr int | SNR (Signal to Noise Ratio) observed from last polling during the session
ssid String | SSID
throughput double | Average session throughput
userName String | Client Username
vlan int | Vlan name
webSecurity WebSecurityEnum | Flag to indicate whether the client is authenticated via WebAuth Allowed values DISABLED ENABLED
wgbMacAddress MacAddress | WGB MAC Address if it is a WGB client
wgbStatus WGBStatusEnum | Flag to indicate whether the client is WGB client, WGB AP or local client Allowed values REGULARCLIENT WGBCLIENT WGBAP

## 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/ClientSessions/15

    <?xml version="1.0" ?>
    <queryResponse type="ClientSessions" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/ClientSessions/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="clientSessionsDTO" type="ClientSessions" url="https://10.64.88.203/webacs/api/v4/data/ClientSessions/15">
        <clientSessionsDTO displayName="String value" id="15" uuid="String value">
          <adDomainName>String value</adDomainName>
          <authenticationAlgorithm>OPENSYSTEM</authenticationAlgorithm>
          <authorizationPolicy>String value</authorizationPolicy>
          <bytesReceived>2</bytesReceived>
          <bytesSent>2</bytesSent>
          <clientInterface>String value</clientInterface>
          <connectionType>LIGHTWEIGHTWIRELESS</connectionType>
          <ctsSecurityGroup>String value</ctsSecurityGroup>
          <deviceName>String value</deviceName>
          <eapType>EAPTLS</eapType>
          <encryptionCypher>CCMPAES</encryptionCypher>
          <ipType>IPV4</ipType>
          <location>String value</location>
          <packetsReceived>2</packetsReceived>
          <packetsSent>2</packetsSent>
          <policyTypeStatus>IDLE</policyTypeStatus>
          <portSpeed>UNKNOWN</portSpeed>
          <postureStatus>UNKNOWN</postureStatus>
          <profileName>String value</profileName>
          <protocol>UNDEFINED</protocol>
          <roamReason>String value</roamReason>
          <rssi>1</rssi>
          <securityPolicy>DOT1X</securityPolicy>
          <sessionEndTime>2</sessionEndTime>
          <sessionStartTime>2</sessionStartTime>
          <snr>1</snr>
          <ssid>String value</ssid>
          <throughput>4.0</throughput>
          <userName>String value</userName>
          <webSecurity>DISABLED</webSecurity>
          <wgbStatus>REGULARCLIENT</wgbStatus>
          <anchorIpAddress>
            <address>192.168.115.243</address>
          </anchorIpAddress>
          <apMacAddress>
            <octets>000a959d6816</octets>
          </apMacAddress>
          <deviceMgmtAddress>
            <address>192.168.115.243</address>
          </deviceMgmtAddress>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <vlan>1</vlan>
          <wgbMacAddress>
            <octets>000a959d6816</octets>
          </wgbMacAddress>
        </clientSessionsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "ClientSessions",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/ClientSessions/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "clientSessionsDTO",
          "@type" : "ClientSessions",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/ClientSessions/15",
          "clientSessionsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "adDomainName" : "String value",
            "anchorIpAddress" : {
              "address" : "192.168.115.243"
            },
            "apMacAddress" : {
              "octets" : "000a959d6816"
            },
            "authenticationAlgorithm" : "OPENSYSTEM",
            "authorizationPolicy" : "String value",
            "bytesReceived" : 2,
            "bytesSent" : 2,
            "clientInterface" : "String value",
            "connectionType" : "LIGHTWEIGHTWIRELESS",
            "ctsSecurityGroup" : "String value",
            "deviceMgmtAddress" : {
              "address" : "192.168.115.243"
            },
            "deviceName" : "String value",
            "eapType" : "EAPTLS",
            "encryptionCypher" : "CCMPAES",
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "ipType" : "IPV4",
            "location" : "String value",
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "packetsReceived" : 2,
            "packetsSent" : 2,
            "policyTypeStatus" : "IDLE",
            "portSpeed" : "UNKNOWN",
            "postureStatus" : "UNKNOWN",
            "profileName" : "String value",
            "protocol" : "UNDEFINED",
            "roamReason" : "String value",
            "rssi" : 1,
            "securityPolicy" : "DOT1X",
            "sessionEndTime" : 2,
            "sessionStartTime" : 2,
            "snr" : 1,
            "ssid" : "String value",
            "throughput" : 4.0,
            "userName" : "String value",
            "vlan" : 1,
            "webSecurity" : "DISABLED",
            "wgbMacAddress" : {
              "octets" : "000a959d6816"
            },
            "wgbStatus" : "REGULARCLIENT"
          }
        } ]
      }
    }