LdapDirectoryQueryRoot Property

General info

Label

Query Root

Description

The container on the Active Directory to use as the root for validating users and to query for the groups a user is member of.

Data type

String

Default value

"CN=Users"

Type

Regular

Code

2829

Symbolic name

MODEL_PROP_LDAPDIRECTORYQUERYROOT

Lua access code

syslib.model.properties.LdapDirectoryQueryRoot

Available since

1.34
Parent properties

WebAPIAuthentication

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_HAS_DEFAULT The property has a default value as standard.

Examples

Read from or write to the LdapDirectoryQueryRoot property.

  • Lua

  • C#

-- Read from the LdapDirectoryQueryRoot
syslib.getvalue("<OBJECT FULL PATH>.WebAPIAuthentication.LdapDirectoryQueryRoot")

-- Write to the LdapDirectoryQueryRoot
syslib.setvalue("<OBJECT FULL PATH>.WebAPIAuthentication.LdapDirectoryQueryRoot", "CN=Users")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the LdapDirectoryQueryRoot
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.WebAPIAuthentication.LdapDirectoryQueryRoot"));
// Write to the LdapDirectoryQueryRoot
Result result = sli.WriteValue(sc, new WriteItem("CN=Users", "<OBJECT FULL PATH>.WebAPIAuthentication.LdapDirectoryQueryRoot"));