Apache CloudStack 4.18.0.0 Root Admin API Reference

listLdapUsers

Lists LDAP Users according to the specifications from the user request.

Request parameters

Parameter NameDescriptionRequired
domainidlinked domainfalse
keywordList by keywordfalse
listtypeDetermines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameterfalse
pagefalse
pagesizefalse
userfilterDetermines what type of filter is applied on the list of users returned from LDAP. valid values are 'NoFilter' no filtering is done, 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSourcefalse

Response Tags

Response NameDescription
conflictingusersourceThe authentication source for this user as known to the system or empty if the user is not yet in cloudstack.
domainThe user's domain
emailThe user's email
firstnameThe user's firstname
lastnameThe user's lastname
principalThe user's principle
usernameThe user's username