Get Authentication and Policy Servers - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get Authentication and Policy Servers","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getAuthenticationAndPolicyServers","tags":["System Settings"],"summary":"Get Authentication and Policy Servers","deprecated":false,"description":"API to get Authentication and Policy Servers","parameters":[{"name":"isIseEnabled","description":"Valid values are : true, false","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"state","description":"Valid values are: ACTIVE, DELETED, FAILED, INACTIVE, INPROGRESS, RBAC-FAILURE, RBAC-SUCCESS","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"role","description":"Authentication and Policy Server Role (Example: primary, secondary)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string","description":"IP address of authentication and policy server (readonly)"},"sharedSecret":{"type":"string","description":"Shared secret between devices and authentication and policy server (readonly)"},"protocol":{"type":"string","enum":["TACACS","RADIUS","RADIUS_TACACS"],"description":"Type of protocol for authentication and policy server. If already saved with RADIUS, can update to RADIUS_TACACS. If already saved with TACACS, can update to RADIUS_TACACS"},"role":{"type":"string","description":"Role of authentication and policy server (readonly). E.g. primary, secondary"},"port":{"type":"integer","description":"Port of TACACS server (readonly). The range is from 1 to 65535. Default is 49."},"authenticationPort":{"type":"integer","description":"Authentication port of RADIUS server (readonly). The range is from 1 to 65535. Default is 1812. E.g. 1812"},"accountingPort":{"type":"integer","description":"Accounting port of RADIUS server (readonly). The range is from 1 to 65535. Default is 1813. E.g. 1813"},"retries":{"type":"integer","description":"Number of communication retries between devices and authentication and policy server. The range is from 1 to 3. Default is 3"},"timeoutSeconds":{"type":"integer","description":"Number of seconds before timing out between devices and authentication and policy server. The range is from 2 to 20"},"isIseEnabled":{"type":"boolean","description":"Value true for Cisco ISE Server (readonly). Default value is false"},"instanceUuid":{"type":"string","description":"Internal record identifier"},"state":{"type":"string","enum":["ACTIVE","INACTIVE","RBAC_SUCCESS","RBAC_FAILURE","DELETED","FAILED","INPROGRESS"],"description":"State of authentication and policy server"},"ciscoIseDtos":{"type":"array","items":{"type":"object","properties":{"subscriberName":{"type":"string","description":"Subscriber name of the Cisco ISE server (readonly). E.g. pxgrid_client_1662589467"},"description":{"type":"string","description":"Description about the Cisco ISE server"},"password":{"type":"string","description":"Password of the Cisco ISE server. For security reasons the value will always be empty"},"userName":{"type":"string","description":"User name of the Cisco ISE server"},"fqdn":{"type":"string","description":"Fully-qualified domain name of the Cisco ISE server (readonly). E.g. xi-62.my.com"},"ipAddress":{"type":"string","description":"IP Address of the Cisco ISE Server (readonly)"},"trustState":{"type":"string","enum":["TRUSTED","UNTRUSTED","INIT"],"description":"Trust State between DNAC and the ISE server"},"instanceUuid":{"type":"string","description":"Internal record identifier"},"sshkey":{"type":"string","description":"SSH key of the Cisco ISE server. For security reasons the value will always be empty"},"type":{"type":"string","description":"Type (Example: ISE)"},"failureReason":{"type":"string","description":"Reason for integration failure between DNAC and the ISE server"},"role":{"type":"string","enum":["PRIMARY","SECONDARY","PXGRID"],"description":"Role of the Cisco ISE server"},"externalCiscoIseIpAddrDtos":{"type":"object","properties":{"type":{"type":"string","description":""},"externalCiscoIseIpAddresses":{"type":"array","items":{"type":"object","properties":{"externalIpAddress":{"type":"string","description":""}}},"description":""}},"description":"For future use"}}},"description":"ISE metadata"},"encryptionScheme":{"type":"string","enum":["KEYWRAP","RADSEC"],"description":"Type of encryption scheme for additional security (readonly)"},"messageKey":{"type":"string","description":"Encryption key used to encrypt shared secret (readonly)"},"encryptionKey":{"type":"string","description":"Encryption key used to encrypt shared secret"},"useDnacCertForPxgrid":{"type":"boolean","description":"Value true to use DNAC certificate for Pxgrid. Default value is false"},"iseEnabled":{"type":"boolean","description":"Value true for Cisco ISE Server (readonly). Default value is false"},"pxgridEnabled":{"type":"boolean","description":"Value true for enable, false for disable. Default value is true"},"rbacUuid":{"type":"string","description":"Internal use only"},"multiDnacEnabled":{"type":"boolean","description":"Internal use only"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetAuthenticationAndPolicyServersResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"a4b4-c849-4be8-b362","x-rapi-overview":"API to get Authentication and Policy Servers","x-rapi-domain":"System Settings","x-rapi-subdomain":"","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/aaa","x-rapi-publicPath":"/dna/intent/api/v1/authentication-policy-servers","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"__originalOperationId":"getAuthenticationAndPolicyServers","method":"get","path":"/dna/intent/api/v1/authentication-policy-servers"}}