AncEndpoint - Cisco pxGrid API

{"type":"model","meta":{"id":"/apps/pubhub/media/pxgrid-api/d2ed45b3bda7a743732a662f4140de098593c8e2/7043f64c-b34c-3c6b-bbec-7883cd142659","info":{"title":"Cisco pxGrid Complete API","description":"Complete API specification for Cisco pxGrid Control, Session Directory, System Health, TrustSec Configuration, Endpoint, TrustSec SXP, RADIUS Failures, MDM Endpoints, Profiler Configuration, and ANC Configuration services.\n\nThis specification includes:\n- [Session Directory](#session-directory-object-fields)\n- [System Health](#system-health-object-fields)\n- [TrustSec Configuration](#trustsec-configuration-object-fields)\n- [Endpoint](#iseendpoint-object-fields)\n- [TrustSec SXP](#sxpbinding-object-fields)\n- [RADIUS Failures](#radiusfailure-object-fields)\n- [MDM Endpoints](#mdmendpoint-object-fields)\n- [Profiler Configuration](#profile-object-fields)\n- [ANC Configuration](#anc-configuration-object-fields)\n\nThe objects returned by the various services and details on which ISE versions may return certain attributes are defined below.\n\n\u003ca id=\"session-directory-object-fields\"\u003e\u003c/a\u003e\n## Session Directory\n\u003ca id=\"session-object-fields\"\u003e\u003c/a\u003e\n### Session Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-session-by-ip-address/#get-sessions-API\" target=\"_self\"\u003eView Session Directory APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-----------------|\n| `adHostDomainName` | string | Active Directory host domain name | 2.3 |\n| `adHostNetBiosName` | string | Active Directory host NetBIOS name | 2.3 |\n| `adHostQualifiedName` | string | Active Directory host qualified name | 2.4p9 2.6p2 2.7 |\n| `adHostResolvedDns` | string | Active Directory host resolved DNS | 2.3 |\n| `adHostResolvedIdentities` | string | Active Directory host resolved identities | 2.3 |\n| `adHostSamAccountName` | string | Active Directory host SAM account name | 2.4p9 2.6p2 2.7 |\n| `adNormalizedUser` | string | Normalized Active Directory username | 2.3 |\n| `adUserDomainName` | string | Active Directory user domain name | 2.3 |\n| `adUserNetBiosName` | string | Active Directory user NetBIOS name | 2.3 |\n| `adUserQualifiedName` | string | Active Directory user qualified name | 2.4p9 2.6p2 2.7 |\n| `adUserResolvedDns` | string | Active Directory user resolved DNS | 2.3 |\n| `adUserResolvedIdentities` | string | Active Directory user resolved identities | 2.3 |\n| `adUserSamAccountName` | string | Active Directory user SAM account name | 2.4p9 2.6p2 2.7 |\n| `airespaceWlanId` | string | Airespace WLAN identifier | 2.3 |\n| `ancPolicy` | string | The Adaptive Network Control policy applied to this endpoint | 2.4 |\n| `auditSessionId` | string | Audit Session ID generated uniquely by switch/router for a given session | 2.3 |\n| `calledStationId` | string | The called station identifier | 2.3 |\n| `callingStationId` | string | The calling station identifier | 2.3 |\n| `ctsSecurityGroup` | string | Trustsec security group name | 2.3 |\n| `endpointCheckResult` | string | Endpoint check result | 2.3 |\n| `endpointCheckTime` | string | Time when endpoint check was performed | 2.3 |\n| `endpointOperatingSystem` | string | Operating system of the endpoint | 2.3 |\n| `endpointProfile` | string | Profile of the endpoint | 2.3 |\n| `identitySourcePortEnd` | string | End of source port range of the virtual desktop environment | 2.3 |\n| `identitySourcePortFirst` | string | First source port of the virtual desktop environment | 2.3 |\n| `identitySourcePortStart` | string | Start of source port range of the virtual desktop environment | 2.3 |\n| `ipAddresses` | array of string | IPv4 or IPv6 addresses | 2.3 |\n| `isMachineAuthentication` | string | Determine if this is a machine authentication (true for a machine, false for ... | 2.3 |\n| `macAddress` | string | MAC address in uppercase colon separated format XX:XX:XX:XX:XX:XX | 2.3 |\n| `mdmCompliant` | boolean | Whether the device is compliant with policies | 2.4 |\n| `mdmDeviceManager` | string | Device management system information | 2.4 |\n| `mdmDiskEncrypted` | boolean | Whether device storage is encrypted | 2.4 |\n| `mdmImei` | string | International Mobile Equipment Identity | 2.4 |\n| `mdmJailBroken` | boolean | Whether device is jailbroken/rooted | 2.4 |\n| `mdmLastSyncTime` | string | Last synchronization time with MDM | 2.4 |\n| `mdmLocation` | string | Device location information | 2.4 |\n| `mdmMacAddress` | string | Mobile Device Management MAC address | 2.4 |\n| `mdmManufacturer` | string | Device manufacturer | 2.4 |\n| `mdmMeid` | string | Mobile Equipment Identifier | 2.4 |\n| `mdmModel` | string | Device model | 2.4 |\n| `mdmOsVersion` | string | Mobile Device Management OS version | 2.4 |\n| `mdmPinLocked` | boolean | Whether device is PIN/password protected | 2.4 |\n| `mdmRegistered` | boolean | Whether the device is registered with MDM | 2.4 |\n| `mdmSerialNumber` | string | Device serial number | 2.4 |\n| `mdmUdid` | string | Unique Device Identifier | 2.4 |\n| `nasIdentifier` | string | Network Access Server identifier | 2.3 |\n| `nasIpAddress` | string | IPv4 or IPv6 address of the network access device | 2.3 |\n| `nasPortId` | string | Network Access Server port identifier | 2.3 |\n| `nasPortType` | string | Network Access Server port type | 2.3 |\n| `networkDeviceProfileName` | string | Network device profile name | 2.3 |\n| `postureStatus` | string | Posture status of the endpoint (Compliant or NonCompliant) | 2.3 |\n| `providers` | array of string | Providers of this session information | 2.3 |\n| `radiusFlowType` | string | RADIUS flow type | 2.3 |\n| `selectedAuthzProfiles` | array of string | Selected authorization profiles for the session | 2.4p12 2.6p5 2.7p1 3.0 |\n| `serviceType` | string | Service type | 2.3 |\n| `ssid` | string | Service Set Identifier for wireless networks | 2.3 |\n| `state` | string | Current state of the session, where DISCONNECTED indicates a terminated session | 2.3 |\n| `terminalServerAgentId` | string | Terminal Server Agent ID | 2.3 |\n| `timestamp` | string | The time that the session record was created or updated in ISE | 2.3 |\n| `tunnelPrivateGroupId` | string | Tunnel private group identifier | 2.3 |\n| `userName` | string | Username of the authenticated user | 2.3 |\n| `virtualNetwork` | string | Virtual network identifier | 3.0 |\n\n\u003ca id=\"usergroup-object-fields\"\u003e\u003c/a\u003e\n### User Group Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-all-user-groups/#get-user-groups-API\" target=\"_self\"\u003eView User Group APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|----------------|------|-------------|-------------|\n| `groups` | array | List of security groups associated with this user | 2.3 |\n| `userName` | string | Username of the authenticated user | 2.3 |\n\n\u003ca id=\"group-object-fields\"\u003e\u003c/a\u003e\n### Group Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-user-groups-by-username/#get-groups-API\" target=\"_self\"\u003eView Group APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|----------------|------|-------------|-------------|\n| `name` | string | The name of the security group | 2.3 |\n| `type` | string | The type of security group (ISE 2.3+) | 2.3 |\n\n\u003ca id=\"system-health-object-fields\"\u003e\u003c/a\u003e\n## System Health\n\u003ca id=\"health-object-fields\"\u003e\u003c/a\u003e\n### Health Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-system-health-information/#get-system-health-API\" target=\"_self\"\u003eView System Health APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `timestamp` | string | The time this record was created in ISE | 2.3 |\n| `serverName` | string | ISE server name where data is recorded | 2.3 |\n| `ioWait` | number | Percentage of I/O wait for the last 5 minutes | 2.3 |\n| `cpuUsage` | number | Percentage of CPU usage for the last 5 minutes | 2.3 |\n| `memoryUsage` | number | Percentage of total memory usage | 2.3 |\n| `diskUsageRoot` | number | Percentage of disk space usage of root directory | 2.3 |\n| `diskUsageOpt` | number | Percentage of disk space usage of opt directory | 2.3 |\n| `loadAverage` | number | The average number of jobs in the run queue for the last 5 minutes | 2.3 |\n| `networkSent` | number | Bytes sent for the last 5 minutes | 2.3 |\n| `networkReceived` | number | Bytes received for the last 5 minutes | 2.3 |\n\n\u003ca id=\"performance-object-fields\"\u003e\u003c/a\u003e\n### Performance Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-system-performance-metrics/#get-system-performance-API\" target=\"_self\"\u003eView Performance APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `timestamp` | string | The time this record was created in ISE | 2.3 |\n| `serverName` | string | ISE server name where data is recorded | 2.3 |\n| `radiusRate` | number | Average transactions per second of Radius requests since startTimestamp | 2.3 |\n| `radiusCount` | number | Total Radius requests count since startTimestamp | 2.3 |\n| `radiusLatency` | number | Average latency for all Radius requests in milliseconds since startTimestamp | 2.3 |\n\n\u003ca id=\"trustsec-configuration-object-fields\"\u003e\u003c/a\u003e\n## TrustSec Configuration\n\u003ca id=\"securitygroup-object-fields\"\u003e\u003c/a\u003e\n### Security Group Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-security-groups/#get-security-groups-API\" target=\"_self\"\u003eView Security Group APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `description` | string | Human-readable description of the security group | 2.4 |\n| `id` | string | Unique identifier for the security group | 2.4 |\n| `name` | string | Name of the security group | 2.4 |\n| `tag` | integer | Security Group Tag (SGT) value | 2.4 |\n| `timestamp` | string | Time when the security group was created or last modified | 3.2 |\n\n\u003ca id=\"securitygroupacl-object-fields\"\u003e\u003c/a\u003e\n### Security Group ACL Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-security-group-acls/#get-security-group-acls-API\" target=\"_self\"\u003eView Security Group ACL APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `acl` | string | ACL content defining access control rules | 2.4 |\n| `description` | string | Human-readable description of the security group ACL | 2.4 |\n| `generationId` | string | Generation identifier for tracking changes | 2.4 |\n| `id` | string | Unique identifier for the security group ACL | 2.4 |\n| `ipVersion` | string | IP version (IPv4 or IPv6) that this ACL applies to | 2.4 |\n| `isDeleted` | boolean | Flag indicating whether the security group ACL has been deleted | 2.4p13 2.6p9 2.7 |\n| `modelledContent` | object | Structured representation of the ACL content (ISE 3.1+) | 3.1 |\n| `name` | string | Name of the security group ACL | 2.4 |\n| `timestamp` | string | Time when the security group ACL was created or last modified | 3.2 |\n\n\u003ca id=\"virtualnetwork-object-fields\"\u003e\u003c/a\u003e\n### Virtual Network Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-virtual-networks/#get-virtual-networks-API\" target=\"_self\"\u003eView Virtual Network APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `additionalAttributes` | string | Additional attributes in JSON string format | 3.1 |\n| `id` | string | Unique identifier for the virtual network | 3.1 |\n| `name` | string | Name of the virtual network | 3.1 |\n| `timestamp` | string | Time when the virtual network was created or last modified | 3.1 3.2 |\n\n\u003ca id=\"egresspolicy-object-fields\"\u003e\u003c/a\u003e\n### Egress Policy Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-egress-policies/#get-egress-policies-API\" target=\"_self\"\u003eView Egress Policy APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `id` | string | Unique identifier for the egress policy | 2.3 |\n| `name` | string | Name of the egress policy | 2.3 |\n| `matrixId` | string | Matrix this policy belongs to | 2.3 |\n| `status` | string | Status of the egress policy (ENABLE, MONITOR) | 2.3 |\n| `description` | string | Human-readable description of the egress policy | 2.3 |\n| `sourceSecurityGroupId` | string | Source security group ID | 2.3 |\n| `destinationSecurityGroupId` | string | Destination security group ID | 2.3 |\n| `sgaclIds` | array of string | IDs of the SGACLs being used | 2.3 |\n| `timestamp` | string | Time when the egress policy was created or last modified | 3.2 |\n\n\u003ca id=\"egressmatrix-object-fields\"\u003e\u003c/a\u003e\n### Egress Matrix Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-egress-matrices/#get-egress-matrices-API\" target=\"_self\"\u003eView Egress Matrix APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `id` | string | Unique identifier for the egress matrix | 2.3 |\n| `name` | string | Name of the egress matrix | 2.3 |\n| `description` | string | Human-readable description of the egress matrix | 2.3 |\n| `monitorAll` | boolean | Whether to monitor all traffic in this matrix | 2.3 |\n| `timestamp` | string | Time when the egress matrix was created or last modified | 3.2 |\n\n## Endpoint\n\u003ca id=\"iseendpoint-object-fields\"\u003e\u003c/a\u003e \n### ISE Endpoint Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-endpoint-details/#get-ise-endpoint-API\" target=\"_self\"\u003eView ISE Endpoint APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|-----------------------------------|---------|------------------------------------------------------------------|-------------|\n| `aaaServer` | string | PSN's hostname | 3.3 |\n| `allowedProtocolMatchedRule` | string | Matched protocol rule | 3.3 |\n| `authenticationIdentityStore` | string | Identity store used for authentication | 3.3 |\n| `authenticationMethod` | string | Protocol used to authenticate | 3.3 |\n| `authorizationPolicyMatchedRule` | string | Authorization policy matched rule | 3.3 |\n| `byodRegistration` | string | BYOD registration status | 3.3 |\n| `cacheUpdateTime` | string | Time in EPOCH | 3.3 |\n| `callingStationId` | string | Calling station identifier | 3.3 |\n| `createTime` | string | Time in EPOCH | 3.3 |\n| `customAttributes` | object | JSON string containing key-value pairs of custom attributes of endpoint | 3.3 |\n| `destinationIpAddress` | string | Destination IP address | 3.3 |\n| `destinationPort` | string | Destination port | 3.3 |\n| `deviceIdentifier` | string | Device identifier | 3.3 |\n| `deviceIpAddress` | string | NAD's IP Address | 3.3 |\n| `devicePort` | string | Device port of the endpoint | 3.3 |\n| `deviceRegistrationStatus` | string | Registration status (Registered or NotRegistered) | 3.3 |\n| `dhcpHostName` | string | DHCP hostname | 3.3 |\n| `edfCreateTime` | string | Creation time of the endpoint | 3.3 |\n| `edfUpdateTime` | string | Update time of the endpoint | 3.3 |\n| `endPointMACAddress` | string | Endpoint MAC address | 3.3 |\n| `endPointPolicy` | string | Endpoint policy | 3.3 |\n| `endPointPolicyID` | string | Endpoint policy identifier | 3.3 |\n| `endPointProfilerServer` | string | Endpoint profiler server | 3.3 |\n| `endpointSource` | string | Source of the endpoint information | 3.3 |\n| `failureReason` | string | Reason for authentication failure | 3.3 |\n| `firstCollection` | string | First collection timestamp | 3.3 |\n| `framedIpAddress` | string | IP address of the endpoint | 3.3 |\n| `framedIpNetmask` | string | IP netmask of the endpoint | 3.3 |\n| `identityGroup` | string | Identity group name | 3.3 |\n| `identityGroupID` | string | Identity group identifier | 3.3 |\n| `identityPolicyMatchedRule` | string | Rule name of policy which matched | 3.3 |\n| `ip` | string | IP address of the endpoint | 3.3 |\n| `lastActivity` | string | Time of last activity | 3.3 |\n| `lastNmapScanTime` | string | Last Nmap scan time | 3.3 |\n| `location` | string | Location information | 3.3 |\n| `logicalProfile` | string | Logical profile | 3.3 |\n| `macAddress` | string | MAC address of the endpoint | 3.3 |\n| `matchedPolicy` | string | Matched policy name | 3.3 |\n| `matchedPolicyID` | string | Identifier for matched policy | 3.3 |\n| `mdmServerId` | string | MDM server identifier | 3.3 |\n| `messageCode` | string | Message code which is responsible for creation of the endpoint | 3.3 |\n| `mfcInfoDeviceType` | string | Provides information about the device type | 3.3 |\n| `mfcInfoEndpointType` | string | Provides information about the endpoint type | 3.3 |\n| `mfcInfoHardwareManufacturer` | string | Provides information about the Hardware Manufacturer | 3.3 |\n| `mfcInfoHardwareModel` | string | Provides information about the hardware model | 3.3 |\n| `nadDeviceType` | string | NAD device type | 3.3 |\n| `nasIdentifier` | string | Network Access Server identifier | 3.3 |\n| `nasIpAddress` | string | Network Access Server's IP address | 3.3 |\n| `nasPort` | string | Network Access Server port | 3.3 |\n| `nasPortId` | string | Network Access Server port ID | 3.3 |\n| `nasPortType` | string | Network Access Server port type (Ethernet, Wireless, VPN) | 3.3 |\n| `networkDeviceGroups` | string | Comma separated network device groups | 3.3 |\n| `networkDeviceName` | string | Network device name | 3.3 |\n| `nmapScanCount` | string | Nmap scan count | 3.3 |\n| `nmapSubnetScanID` | string | Nmap subnet scan identifier | 3.3 |\n| `oui` | string | Vendor's ID of the network adapter | 3.3 |\n| `phoneId` | string | Phone identifier | 3.3 |\n| `policyVersion` | string | Version of the policies used to profile the endpoint | 3.3 |\n| `portalUser` | string | Portal username | 3.3 |\n| `postureApplicable` | string | Posture applicability | 3.3 |\n| `postureAssessmentStatus` | string | Posture assessment status | 3.3 |\n| `registrationTimeStamp` | string | Registration timestamp | 3.3 |\n| `selectedAccessService` | string | Policy engine team to contact | 3.3 |\n| `selectedAuthenticationIdentityStores` | string | Comma separated Identity stores | 3.3 |\n| `selectedAuthorizationProfiles` | string | Selected authorization profiles | 3.3 |\n| `sequence` | integer | Sequence number for loss detection (From ISE 3.5 onwards) | 3.5 |\n| `staticAssignment` | string | Static assignment status (True or False) | 3.3 |\n| `staticGroupAssignment` | string | Static group assignment status (True or False) | 3.3 |\n| `timeToProfile` | string | Time taken to profile the endpoint | 3.3 |\n| `totalCertaintyFactor` | string | Certainty factor value assigned to the endpoint during profiling | 3.3 |\n| `uniqueSubjectId` | string | Unique subject identifier | 3.3 |\n| `updateTime` | string | Update time | 3.3 |\n| `userFetchEmail` | string | Email address of the user | 3.3 |\n| `userFetchFirstName` | string | First name of the user | 3.3 |\n| `userFetchLastName` | string | Last name of the user | 3.3 |\n| `userFetchUserName` | string | Username of the user | 3.3 |\n| `userName` | string | Username | 3.3 |\n| `userType` | string | Type of user | 3.3 |\n\n## TrustSec SXP\n\u003ca id=\"sxpbinding-object-fields\"\u003e\u003c/a\u003e\n### SXP Binding Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-sxp-bindings/#get-bindings-API\" target=\"_self\"\u003eView SXP Binding APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `tag` | string | SXP security group tag | 2.3 |\n| `ipPrefix` | string | IP address prefix with subnet mask | 2.3 |\n| `source` | string | Source IP address | 2.3 |\n| `peerSequence` | string | Peer sequence identifier | 2.3 |\n| `vpn` | string | VPN instance identifier | 2.3 |\n\n## RADIUS Failures\n\u003ca id=\"radiusfailure-object-fields\"\u003e\u003c/a\u003e\n### RadiusFailure Object Fields\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-radius-failures/#get-radius-failures-API\" target=\"_self\"\u003eView RadiusFailure APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `id` | string | Unique identifier for the failure record | 2.3 |\n| `timestamp` | string | The time this record was created in ISE | 2.3 |\n| `failureReason` | string | The reason for the authentication failure | 2.3 |\n| `userName` | string | Username that failed authentication | 2.3 |\n| `serverName` | string | ISE server name where failure occurred | 2.3 |\n| `callingStationId` | string | RADIUS Calling-Station-ID | 2.3 |\n| `auditSessionId` | string | Audit session identifier | 2.3 |\n| `nasIpAddress` | string | Network Access Server IP address | 2.3 |\n| `nasPortId` | string | Network Access Server port identifier | 2.3 |\n| `nasPortType` | string | Network Access Server port type | 2.3 |\n| `ipAddresses` | array of string | IP addresses associated with the failure | 2.3 |\n| `macAddress` | string | MAC address of the device | 2.3 |\n| `messageCode` | integer | ISE syslog message code (5400-5499) | 2.3 |\n| `destinationIpAddress` | string | Destination IP address | 2.3 |\n| `userType` | string | Type of user | 2.3 |\n| `accessService` | string | Access service used | 2.3 |\n| `identityStore` | string | Identity store used for authentication | 2.3 |\n| `identityGroup` | string | Identity group of the user | 2.3 |\n| `authenticationMethod` | string | Authentication method used | 2.3 |\n| `authenticationProtocol` | string | Authentication protocol used | 2.3 |\n| `serviceType` | string | Service type | 2.3 |\n| `networkDeviceName` | string | Name of the network device | 2.3 |\n| `deviceType` | string | Type of device | 2.3 |\n| `location` | string | Location of the device | 2.3 |\n| `selectedAznProfiles` | string | Selected authorization profiles | 2.3 |\n| `postureStatus` | string | Posture assessment status | 2.3 |\n| `ctsSecurityGroup` | string | Cisco TrustSec security group | 2.3 |\n| `response` | string | RADIUS response details | 2.3 |\n| `responseTime` | integer | Time taken to respond in milliseconds | 2.3 |\n| `executionSteps` | string | Execution steps during authentication | 2.3 |\n| `credentialCheck` | string | Credential check method | 2.3 |\n| `endpointProfile` | string | Endpoint profile | 2.3 |\n| `mdmServerName` | string | MDM server name | 2.3 |\n| `policySetName` | string | Policy set name | 2.3 |\n| `authorizationRule` | string | Authorization rule | 2.3 |\n| `mseResponseTime` | integer | MSE response time | 2.3 |\n| `mseServerName` | string | MSE server name | 2.3 |\n| `originalCallingStationId` | string | Original calling station identifier | 2.3 |\n\n## MDM Endpoints\n\u003ca id=\"mdmendpoint-object-fields\"\u003e\u003c/a\u003e\n### MDM Endpoints Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-all-mdm-endpoints/#get-mdm-endpoints-API\" target=\"_self\"\u003eView MDM Endpoints APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `compliant` | boolean | Whether the device is compliant with policies | 2.4 |\n| `deviceManager` | string | MDM system managing the device | 2.4 |\n| `diskEncrypted` | boolean | Whether device storage is encrypted | 2.4 |\n| `imei` | string | International Mobile Equipment Identity | 2.4 |\n| `jailBroken` | boolean | Whether device is jailbroken/rooted | 2.4 |\n| `lastSyncTime` | string | Time of last synchronization with MDM | 2.4 |\n| `location` | string | Device location | 2.4 |\n| `macAddress` | string | MAC address of the mobile device | 2.4 |\n| `manufacturer` | string | Device manufacturer | 2.4 |\n| `meid` | string | Mobile Equipment Identifier | 2.4 |\n| `model` | string | Device model | 2.4 |\n| `osVersion` | string | Operating system version | 2.4 |\n| `pinLocked` | boolean | Whether device is PIN/password protected | 2.4 |\n| `registered` | boolean | Whether the device is registered | 2.4 |\n| `serialNumber` | string | Device serial number | 2.4 |\n| `udid` | string | Unique Device Identifier | 2.4 |\n\n## Profiler Configuration\n\u003ca id=\"profile-object-fields\"\u003e\u003c/a\u003e\n### Profile Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-all-profiles/#get-profiles-API\" target=\"_self\"\u003eView Profile APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `id` | string | Unique identifier for the profile | 2.3 |\n| `name` | string | Short name of the profile | 2.3 |\n| `fullName` | string | Full name of the profile | 2.3 |\n\n\u003ca id=\"anc-configuration-object-fields\"\u003e\u003c/a\u003e \n## ANC Configuration\n\u003ca id=\"ancpolicy-object-fields\"\u003e\u003c/a\u003e\n### AncPolicy Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-all-policies/#get-anc-policies-API\" target=\"_self\"\u003eView AncPolicy APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `actions` | array of AncAction | List of actions defined for this policy | 2.4 |\n| `name` | string | Name of the policy | 2.4 |\n\n\u003ca id=\"ancendpoint-object-fields\"\u003e\u003c/a\u003e\n### ANC Endpoint Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/get-all-endpoints/#get-anc-endpoints-API\" target=\"_self\"\u003eView AncEndpoint APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `macAddress` | string | MAC address of the endpoint | 2.4 |\n| `policyName` | string | Name of the policy applied to this endpoint | 2.4 |\n\n\u003ca id=\"ancstatus-object-fields\"\u003e\u003c/a\u003e\n### ANC Status Object\n\n**\u003ca href=\"https://devnetapps.cisco.com/docs/pxgrid/apply-policy-to-endpoint-by-mac-address/#get-anc-status-API\" target=\"_self\"\u003eView AncStatus APIs\u003c/a\u003e**\n\n| Attribute Name | Type | Description | ISE Version |\n|---------------------------|---------|---------------------------|-------------|\n| `failureReason` | string | The reason if operation fails | 2.4 |\n| `macAddress` | string | MAC address where operation is performed | 2.4 |\n| `nasIpAddress` | string | NAS IP address where operation is performed | 2.6p7 2.7p2 3.0 |\n| `operationId` | string | Unique identifier for the operation | 2.4 |\n| `status` | string | Current status of the operation | 2.4 |\n","version":"2.0.0","contact":{"name":"Cisco Systems","url":"https://github.com/cisco-pxgrid/pxgrid-rest-ws"}},"security":[{"BasicAuth":[]}],"tags":[{"name":"pxGrid Control","description":"pxGrid nodes connect to pxGrid Controller to perform control operations that facilitates communications between consumer nodes and provider nodes."},{"name":"Session Directory","description":"This service provides access to ISE Session Directory. There are 2 objects that can be accessed:\n- Session\n- UserGroup\n"},{"name":"System Health","description":"This is ISE System Health service."},{"name":"TrustSec Configuration","description":"This provides the configuration for TrustSec."},{"name":"Endpoint","description":"ISE endpoints are client devices [Eg. Workstations, Mobiles, Printers etc.] which are connected to the ISE managed network devices [Eg. Switches, WLC etc.]. ISE service provides access to these ISE endpoints via the object named **Endpoints**."},{"name":"TrustSec SXP","description":"This is ISE SXP service."},{"name":"RADIUS Failures","description":"This service provides information about Radius protocol. [RFC2865](https://tools.ietf.org/html/rfc2865)"},{"name":"MDM Endpoints","description":"This is Mobile Device Management (MDM) service."},{"name":"Profiler Configuration","description":"This is ISE Profiler configuration\n"},{"name":"ANC Configuration","description":"This is Adaptive Network Control configuration service. This is available in ISE 2.4"}],"externalDocs":{"description":"Overview page","url":"https://devnetapps.cisco.com/docs/pxgrid/overview/"},"openapi":"3.0.0","servers":[{"url":"https://{host}:8910/pxgrid","description":"pxGrid REST API endpoint","variables":{"host":{"default":"localhost","description":"ISE host address"}}},{"url":"wss://{host}:8910/pxgrid/ise/pubsub","description":"pxGrid WebSocket PubSub endpoint","variables":{"host":{"default":"localhost","description":"ISE host address"}}}],"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication using:\n- [nodeName]:[password] for password-based authentication\n- [nodeName]: for certificate-based authentication\n\nNote: Ensure the Basic Auth header is properly encoded and formatted:\n- Format: Basic [base64(nodeName:password)]\n- Example: Basic bXktYXBwLWNvbnN1bWVyLTAxOnZERDRMYnRSc1ZyZVltcVM=\n\nCommon issues:\n1. Ensure correct Base64 encoding of credentials\n2. Verify no extra spaces in the Basic Auth header\n3. Check that nodeName and password are correct\n4. Confirm the account is activated in ISE UI\n"}}},"spec":{"type":"object","description":"Endpoint with associated Adaptive Network Control (ANC) policy information","properties":{"policyName":{"type":"string","description":"Name of the policy applied to this endpoint","example":"Quarantine_Policy","x-ise-version":"2.4"},"macAddress":{"type":"string","description":"MAC address of the endpoint","example":"00:11:22:33:44:55","x-ise-version":"2.4"}},"$$ref":"#/components/schemas/AncEndpoint","title":"AncEndpoint"}}