{"type":"api","title":"Get Enterprise SSID","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"getEnterpriseSSID","tags":["Wireless"],"summary":"Get Enterprise SSID","deprecated":false,"description":"Get Enterprise SSID","parameters":[{"name":"ssidName","description":"Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved.","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":"array","items":{"type":"object","properties":{"instanceUuid":{"type":"string","description":"Instance Uuid"},"version":{"type":"integer","description":"Version"},"ssidDetails":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"SSID Name"},"wlanType":{"type":"string","description":"Wlan Type"},"enableFastLane":{"type":"boolean","description":"Enable Fast Lane"},"securityLevel":{"type":"string","description":"Security Level"},"authServer":{"type":"string","description":"Auth Server"},"passphrase":{"type":"string","description":"Passphrase"},"trafficType":{"type":"string","description":"Traffic Type"},"enableMACFiltering":{"type":"boolean","description":"Enable MAC Filtering"},"isEnabled":{"type":"boolean","description":"Is Enabled"},"isFabric":{"type":"boolean","description":"Is Fabric"},"fastTransition":{"type":"string","description":"Fast Transition"},"radioPolicy":{"type":"string","description":"Radio Policy"},"enableBroadcastSSID":{"type":"boolean","description":"Enable Broadcast SSID"},"nasOptions":{"type":"array","items":{"type":"string"},"description":""},"aaaOverride":{"type":"boolean","description":"Aaa Override"},"coverageHoleDetectionEnable":{"type":"boolean","description":"Coverage Hole Detection Enable"},"protectedManagementFrame":{"type":"string","enum":["Optional","Disabled","Required"],"description":""},"multiPSKSettings":{"type":"array","items":{"type":"object","properties":{"priority":{"type":"integer","description":"Priority"},"passphraseType":{"type":"string","enum":["ASCII","HEX"],"description":"Passphrase Type"},"passphrase":{"type":"string","description":""}}},"description":"Multi PSK Settings"},"clientRateLimit":{"type":"number","description":"Client Rate Limit. (in bits per second)"},"enableSessionTimeOut":{"type":"boolean","description":"Enable Session Time Out"},"sessionTimeOut":{"type":"number","description":"sessionTimeOut"},"enableClientExclusion":{"type":"boolean","description":"Enable Client Exclusion"},"clientExclusionTimeout":{"type":"number","description":"Client Exclusion Timeout"},"enableBasicServiceSetMaxIdle":{"type":"boolean","description":"Enable Basic Service Set Max Idle"},"basicServiceSetClientIdleTimeout":{"type":"number","description":"Basic Service Set ClientIdle Timeout"},"enableDirectedMulticastService":{"type":"boolean","description":"Enable Directed MulticastService"},"enableNeighborList":{"type":"boolean","description":"Enable NeighborList"},"mfpClientProtection":{"type":"string","description":"Mfp Client Protection"}}},"description":"SSID Details"},"groupUuid":{"type":"string","description":"Group Uuid"},"inheritedGroupUuid":{"type":"string","description":"Inherited Group Uuid"},"inheritedGroupName":{"type":"string","description":"Inherited Group Name"}}},"description":"","$$ref":"#/components/schemas/GetEnterpriseSSIDResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"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":"cca5-19ba-45eb-b423","x-rapi-overview":"Get Enterprise SSID","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-banner":["Sunset"],"x-rapi-rateLimiting":"5~1","__originalOperationId":"getEnterpriseSSID","method":"get","path":"/dna/intent/api/v1/enterprise-ssid"}}