T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::LDAP Namespace Reference

Commands to edit the ldap configuration of a BGS. More...

Functions

 addDirectory DirectoryConfiguration
 Adds a new LDAP directory configuration to the list of LDAP directories. More...
 
 checkConfiguration DirectoryConfiguration
 Checks if a LDAP directory configuration defines all required settings. More...
 
 exists DirectoryId
 Checks if a certain configuration id and hence LDAP directory configuration is already existing. More...
 
 getDirectory DirectoryId
 Returns the settings of a specific LDAP directory. More...
 
 getDirectoryList
 Returns a list of all configured LDAP directories and their attributes. More...
 
 removeDirectory DirectoryId
 Removes an existing LDAP directory configuration. More...
 
 setDirectoryList ListOfDirectoryConfigurations
 Sets a the list of LDAP directory configurations. Any existing list will be overwritten. More...
 
 updateDirectory DirectoryConfiguration
 Replaces or updates an existing LDAP directory configuration. More...
 

Detailed Description

Commands to edit the ldap configuration of a BGS.

Function Documentation

◆ addDirectory()

CONFIGURATION::MANAGER::LDAP::addDirectory   DirectoryConfiguration  

Adds a new LDAP directory configuration to the list of LDAP directories.

Parameters
DirectoryConfigurationlist containing all required settings (key value pairs) for the LDAP directory configuration
Returns
nothing
1 set myLDAP [dict create ID my_ldap
2  # HOST my.ldap.host \
3  # PORT 10389 \
4  # BASEDN dc=company,dc=com \
5  # ADMINDN cn=admin,dc=company,dc=com \
6  # ADMINPASSWORD "TODO" \
7  # DEFAULTFILTER "" \
8  # CONNECTIONTYPE plain \
9  # CACERTIFICATE "" \
10  # USERNAMEATTRIBUTE uid \
11  # ]

◆ checkConfiguration()

CONFIGURATION::MANAGER::LDAP::checkConfiguration   DirectoryConfiguration  

Checks if a LDAP directory configuration defines all required settings.

Parameters
DirectoryConfigurationlist containing all required settings (key value pairs) for the LDAP directory configuration
Returns
raises an error if a key value pair is missing or misconfigured, otherwise nothing
1 set myIncompleteDirectoryConfig [dict create ID incomplete PORT 12345]
2 if {[catch {::CONFIGURATION::MANAGER::LDAP::checkConfiguration $myIncompleteDirectoryConfig}]} {
3  puts "An error was raised: $::errorInfo"
4 }

◆ exists()

CONFIGURATION::MANAGER::LDAP::exists   DirectoryId  

Checks if a certain configuration id and hence LDAP directory configuration is already existing.

Parameters
DirectoryIdID of the LDAP directory configuration to be checked
Returns
true if it is already existing, false otherwise
2  puts "my_ldap configuration is missing!"
3 }

◆ getDirectory()

CONFIGURATION::MANAGER::LDAP::getDirectory   DirectoryId  

Returns the settings of a specific LDAP directory.

Parameters
DirectoryIdID of the LDAP directory configuration to be received
Returns
list of settings for the given LDAP directory configuration
1 foreach {key value} [::CONFIGURATION::MANAGER::LDAP::getDirectory my_ldap] {
2  puts "$key is set to $value"
3 }

◆ getDirectoryList()

CONFIGURATION::MANAGER::LDAP::getDirectoryList

Returns a list of all configured LDAP directories and their attributes.

Returns
list of LDAP directories

◆ removeDirectory()

CONFIGURATION::MANAGER::LDAP::removeDirectory   DirectoryId  

Removes an existing LDAP directory configuration.

Parameters
DirectoryIdID of the LDAP directory configuration to be removed
Returns
nothing

◆ setDirectoryList()

CONFIGURATION::MANAGER::LDAP::setDirectoryList   ListOfDirectoryConfigurations  

Sets a the list of LDAP directory configurations. Any existing list will be overwritten.

Parameters
ListOfDirectoryConfigurationslist containing all required settings (key value pairs) for the LDAP directories configuration
Returns
nothing
2 set myLDAP [dict create ID my_ldap
3  # HOST my.ldap.host \
4  # PORT 10389 \
5  # BASEDN dc=company,dc=com \
6  # ADMINDN cn=admin,dc=company,dc=com \
7  # ADMINPASSWORD "TODO" \
8  # DEFAULTFILTER "" \
9  # CONNECTIONTYPE plain \
10  # CACERTIFICATE "" \
11  # USERNAMEATTRIBUTE uid \
12  # ]
13 set extendedLDAPList [lappend existingDirectories $myLDAP]

◆ updateDirectory()

CONFIGURATION::MANAGER::LDAP::updateDirectory   DirectoryConfiguration  

Replaces or updates an existing LDAP directory configuration.

Parameters
DirectoryConfigurationlist containing all required settings (key value pairs) for the LDAP directory configuration
Returns
nothing
1 set myUpdatedLDAP [dict create ID my_ldap
2  # HOST my.ldap.host \
3  # PORT 10389 \
4  # BASEDN dc=company,dc=com \
5  # ADMINDN cn=admin,dc=company,dc=com \
6  # ADMINPASSWORD "TODO" \
7  # DEFAULTFILTER "" \
8  # CONNECTIONTYPE plain \
9  # CACERTIFICATE "" \
10  # USERNAMEATTRIBUTE uid \
11  # ]