{"type":"api","title":"Get list of remote LDAP servers","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/5e144619-25b2-30e4-9a1e-a368d8dadee6","info":{"title":"Crosswork Remote Authentication Server Integration API - Version 1","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","description":"APIs to support integration of the Crosswork platform and remote authentication servers. TACACS+, LDAP, RADIUS, SSO server types are supported."},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/RBAC/auth-remote-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/authconfig/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Use a bearer token to authenticate requests. Include the token in the Authorization header with the prefix 'Bearer '."}}},"spec":{"summary":"Get list of remote LDAP servers","description":"Returns the list of LDAP servers that were configured to integrate with Crosswork.","operationId":"LdapGetAll","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"ldap_server":{"type":"array","items":{"type":"object","required":["name","ldapUrl","bindDn","bindCredential","baseDn","userFilter","dnFormat","principalAttributeId","policyId","order","connectTimeout"],"properties":{"name":{"type":"string","description":"Name of the connection"},"ldapUrl":{"type":"string","description":"URL of the LDAP server"},"bindDn":{"type":"string","description":"Credentials to bind when initializing connections"},"bindCredential":{"type":"string","description":"Credentials to bind when initializing connections"},"baseDn":{"type":"string","description":"Search for the bind user admin will be done starting at the base Distinguished Name (DN)"},"userFilter":{"type":"string","description":"filter to match the users."},"dnFormat":{"type":"string","description":"Format for the Distinguished Name (DN)"},"principalAttributeId":{"type":"string","description":"Key in LDAP for the username of the user"},"policyId":{"type":"string","description":"Key in LDAP for the Crosswork role mapping"},"order":{"type":"string","description":"Priority order of the LDAP server"},"connectTimeout":{"type":"integer","description":"Connection timeout in milliseconds"}},"$$ref":"#/definitions/authconfigLdapServer"},"example":[{"name":"Ldap-132-24","ldapUrl":"ldap://1.2.3.4:10389","bindDn":"cn=admin,dc=example,dc=org","bindCredential":"admin","connectTimeout":5000,"baseDn":"dc=example,dc=org","userFilter":"uid={user}","dnFormat":"uid=%s,dc=example,dc=org","principalAttributeId":"uid","policyId":"crossworkPolicyId","order":1}],"$$ref":"#/definitions/authconfigLdapServers"},"ldap_attr_servers":{"type":"object","properties":{"ldap_attr_server":{"type":"array","items":{"type":"object","required":["baseDn","bindDn","ldapUrl","bindCredential","userFilter","failFast","connectTimeout","attributes"],"properties":{"baseDn":{"type":"string","description":"Search for the bind user admin will be done starting at the base Distinguished Name (DN)"},"bindDn":{"type":"string","description":"Credentials to bind when initializing connections"},"ldapUrl":{"type":"string","description":"URL of the LDAP server"},"bindCredential":{"type":"string","description":"Credentials to bind when initializing connections"},"userFilter":{"type":"string","description":"filter to match the users."},"failFast":{"type":"boolean","description":"Attempt to populate the connection pool early on startup and fail quickly in case of failure."},"connectTimeout":{"type":"integer","description":"Connection timeout in milliseconds"},"trustStore":{"type":"string","description":"Path to the keystore used for LDAPS connection."},"trustStorePassword":{"type":"string","description":"Password to the keystore file used for LDAPS connection."},"trustStoreType":{"type":"string","description":"Type of trust-store for LDAPS connection.","default":"JKS"},"attributes":{"type":"object","description":"Key-value pair. Key maps to the key in LDAP for the Crosswork role mapping. Value maps to the value fetched using the key in LDAP."}},"$$ref":"#/definitions/authconfigLdapAttrServer"},"example":[{"baseDn":"dc=example,dc=org","bindDn":"cn=admin,dc=example,dc=org","ldapUrl":"ldap://1.2.3.4:10389","bindCredential":"admin","userFilter":"uid={user}","failFast":false,"connectTimeout":5000,"trustStore":null,"trustStorePassword":null,"trustStoreType":null,"attributes":{"uid":"policy_id"}}]}},"$$ref":"#/definitions/authconfigLdapAttrServers"}},"$$ref":"#/definitions/authconfigLdapServerAttr"}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error. The server could not fulfill the request."}},"tags":["authconfig"],"__originalOperationId":"LdapGetAll","security":[{"bearerAuth":[]}],"method":"get","path":"/remote/ldap"}}