{"type":"api","title":"Get authentication profiles","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":"getAuthenticationProfiles","tags":["SDA"],"summary":"Get authentication profiles","deprecated":false,"description":"Returns a list of authentication profiles that match the provided query parameters.","parameters":[{"name":"fabricId","description":"ID of the fabric the authentication profile is assigned to.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"authenticationProfileName","description":"Return only the authentication profiles with this specified name. Note that 'No Authentication' is not a valid option for this parameter.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isGlobalAuthenticationProfile","description":"Set to true to return only global authentication profiles, or set to false to hide them. isGlobalAuthenticationProfile must not be true when fabricId is provided.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"offset","description":"Starting record for pagination.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return. The maximum number of objects supported in a single request is 500.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response body contains the result data.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the authentication profile."},"fabricId":{"type":"string","description":"ID of the fabric this authentication profile is assigned to. (This property is not applicable to global authentication profiles and will not be present in such cases.)"},"authenticationProfileName":{"type":"string","enum":["Closed Authentication","Low Impact","Open Authentication"],"description":"The default host authentication template."},"authenticationOrder":{"type":"string","enum":["dot1x","mac"],"description":"First authentication method."},"dot1xToMabFallbackTimeout":{"type":"integer","description":"802.1x Timeout."},"wakeOnLan":{"type":"boolean","description":"Wake on LAN."},"numberOfHosts":{"type":"string","enum":["Single","Unlimited"],"description":"Number of Hosts."},"isBpduGuardEnabled":{"type":"boolean","description":"Enable/disable BPDU Guard. Only applicable when authenticationProfileName is set to \"Closed Authentication\"."},"isVoiceVlanEnabled":{"type":"boolean","description":"Enable/disable Voice Vlan."},"preAuthAcl":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable/disable Pre-Authentication ACL."},"implicitAction":{"type":"string","enum":["PERMIT","DENY"],"description":"Implicit behaviour unless overridden."},"description":{"type":"string","description":"Description of this Pre-Authentication ACL."},"accessContracts":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["PERMIT","DENY"],"description":"Contract behaviour."},"protocol":{"type":"string","enum":["UDP","TCP","TCP_UDP"],"description":"Protocol for the access contract."},"port":{"type":"string","enum":["domain","bootpc","bootps"],"description":"Port for the access contract."}}},"description":"Access contract list schema."}},"description":"Pre-Authentication Access Control List (ACL) schema. This property is only applicable when authenticationProfileName is \"Low Impact\"."}}},"description":"Get response body."},"version":{"type":"string","description":"Version number."}},"description":"Authentication profile get response (Maximum number of records to return in each response is 500).","$$ref":"#/components/schemas/GetAuthenticationProfilesResponse"}}}},"400":{"description":"Request failed due to malformed request syntax.","content":{}},"500":{"description":"Request failed because of unknown failure on the server.","content":{}}},"x-rapi-id":"9eb7-1a2d-44c8-82aa","x-rapi-overview":"Returns a list of authentication profiles that match the provided query parameters.","x-rapi-domain":"Connectivity","x-rapi-subdomain":"SDA","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/sda-helper-service/sda-open-api/authenticationProfiles","x-rapi-publicPath":"/dna/intent/api/v1/sda/authenticationProfiles","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getAuthenticationProfiles","method":"get","path":"/dna/intent/api/v1/sda/authenticationProfiles"}}