Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/systemsettings/ldap

 


Descriptor

Value

HTTP Method

GET

Description

Returns LDAP configuration fields. Password will always be listed as "null".

Restricted

true

 

Required Permission

Manage System Settings

Version Introduced2.5.0.7
Changes in 2.5.2

Adds any additional LDAP server information in response. This information is only present when using version 2.5.2 or later.


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

 


Sample Call:

Code Block
themeEclipse
curl --insecure -H 'Accept: application/json'  -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/systemsettings/ldap

Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "groupsFilter": "(&(objectClass=group)(cn={0}))",
        "password": null,
        "loginFilter": "uid={0}",
        "usersFilter": "objectClass=User",
        "usersGroupsFilter": "(&(memberUid={0})(objectClass=posixGroup))",
        "searchBase": "DC=yourBaseHere,DC=org",
        "url": "ldap://your.url.here",
        "userDn": "CN=user,DC=yourBaseHere,DC=org"
    }
}


Page Tree
rootCI/CD Miscellaneous API