{"type":"api","title":"Manage External Authentication Setting API","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":"manageExternalAuthenticationSettingAPI","tags":["User and Roles"],"deprecated":false,"summary":"Manage External Authentication Setting API","description":"Enable or disable external authentication in the System.\n\nPlease find the Administrator Guide for your particular release from the list linked below and follow the steps required to enable external authentication before trying to do so from this API.\n\nhttps://www.cisco.com/c/en/us/support/cloud-systems-management/dna-center/products-maintenance-guides-list.html","parameters":[{"name":"Content-Type","description":"The format of the payload","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable/disable External Authentication."}},"description":"","$$ref":"#/components/schemas/ManageExternalAuthenticationSettingAPIRequest"}}},"required":true},"responses":{"200":{"description":"Successfully saved External Authentication setting.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"message":{"type":"string","description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/ManageExternalAuthenticationSettingAPIResponse"}}}},"400":{"description":"Either FIPS mode is enabled, invalid request payload, or no AAA/ISE servers have been configured.","content":{}},"500":{"description":"Failed to save External Authentication setting.","content":{}}},"x-rapi-id":"e09c-1806-48da-bb40","x-rapi-overview":"Enable or disable external authentication in the System.\n\nPlease find the Administrator Guide for your particular release from the list linked below and follow the steps required to enable external authentication before trying to do so from this API.\n\nhttps://www.cisco.com/c/en/us/support/cloud-systems-management/dna-center/products-maintenance-guides-list.html","x-rapi-domain":"System","x-rapi-subdomain":"User and Roles","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/system/v1/identitymgmt/aaa-server/external-authentication","x-rapi-publicPath":"/dna/system/api/v1/users/external-authentication","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"10~MINUTE","__originalOperationId":"manageExternalAuthenticationSettingAPI","method":"post","path":"/dna/system/api/v1/users/external-authentication"}}