{"type":"api","title":"Get list of remote RADIUS servers","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/21eb1d117a633ad17a20da730c09f519133958a8/5e144619-25b2-30e4-9a1e-a368d8dadee6","info":{"title":"Crosswork Remote Authentication Server Integration API - Version 1","description":"APIs to support integration of the Crosswork platform and remote authentication servers. TACACS+, LDAP, RADIUS, SSO server types are supported.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/RBAC/auth-remote-v1-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/authconfig/v1"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Use a bearer token to authenticate requests. Include the token in the Authorization header with the prefix 'Bearer '.","name":"Authorization","in":"header"}}},"spec":{"tags":["authconfig"],"summary":"Get list of remote RADIUS servers","description":"Returns the list of RADIUS servers that were configured to integrate with Crosswork.","operationId":"GetAllRadius","responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"radius_servers":{"type":"array","example":[{"host":"1.2.3.4","port":49,"secret":"secret","secretFormat":"secretFormat","timeout":1,"retries":0,"authType":"pap","priority":11,"policyId":"policyx"}],"items":{"required":["authType","host","port","priority","retries","secret","secretFormat"],"type":"object","properties":{"host":{"type":"string","description":"IP Address or hostname"},"port":{"type":"integer","description":"The port number on which the radius server is listening (default is typically 49)."},"secret":{"type":"string","description":"Shared secret"},"secretFormat":{"type":"string","description":"Shared secret format","enum":["ascii","hex"],"$$ref":"#/components/schemas/secretFormatType"},"timeout":{"type":"integer","description":"The re-transmit timeout for requests to the radius server."},"retries":{"type":"integer","description":"The number of times to retry a request to the radius server before failing."},"authType":{"type":"string","description":"Authentication type","enum":["pap","chap"],"$$ref":"#/components/schemas/authTypeEnum"},"priority":{"type":"integer","description":"The priority of this server in a list of multiple remote servers"},"policyId":{"type":"string","description":"Key name for role ID configured on the RADIUS server"}},"$$ref":"#/components/schemas/authconfigRadiusServer"}}},"$$ref":"#/components/schemas/authconfigRadiusServers"}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"500":{"description":"Internal Server Error. The server could not fulfill the request.","content":{}}},"__originalOperationId":"GetAllRadius","security":[{"bearerAuth":[]}],"method":"get","path":"/remote/radius"}}