Salesforce

LDAP Connector - Methods (Magic xpi 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

LDAP Connector - Methods

The following methods are used to configure the LDAP connector:

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name

Parameters

Description

Add Group adds a group to the LDAP server in a specific user DN.

Distinguished Name (DN)

Enter the group distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Error Code

Click to open the Variables list. Select a Variable or User Parameter where the corresponding error code is returned.

Add User adds a user to the LDAP server in a specific user DN.

Distinguished Name (DN)

Enter the user distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

First Name

Enter the new user's first name.

Last Name

Enter the new user's last name.

Password

Enter the new user's password.

Error Code

Click to open the Variables list. Select a Variable or User Parameter where the corresponding error code is returned.

Assign User To Group assigns a user to a group.

User Distinguished Name (DN)

Enter the user distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Group Distinguished Name (DN)

Enter the group distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Error Code

Click to open the Variables list. Select a Variable or User Parameter where the corresponding error code is returned.

Delete Group deletes a group in the specified User DN.

Group Distinguished Name (DN)

Enter the group distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Error Code

Click to open the Variables list. Select a Variable or User Parameter where the corresponding error code is returned.

Delete User deletes a user in the specified User DN.

User Distinguished Name (DN)

Enter the user distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Error Code

Click to open the Variables list. Select a Variable or User Parameter where the corresponding error code is returned.

LDAP Get retrieves the user information.

Search Base

The LDAP path from which to start the search. For example: 'dc=magdomain, dc=com'

Search Level

Determines the level at which you want to search for the user information. Select one of the following from the drop-down list:

  • Base search

  • Sub-tree search

  • One-level search

Search Filter

The LDAP syntax search filter. For example: 'cn=Thomas'

Result attribute

What is being searched for. For example: 'mgr' (the manager attribute)

Delimiter

The delimiter when multiple results are returned. For example '$$$'

Result

A BLOB variable holding the resulting text.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Modify User modifies a user in the specified User DN.

User Distinguished Name (DN)

Enter the user distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Attribute Name

Enter the attribute name that you want to modify.

Operation

Select Modify (default) to perform the modification, or Clear to not perform the modification.

Attribute Value

The value that corresponds to the name that you entered in the Attribute Name parameter. (The Attribute Name and Attribute Value parameters are a name-value pair.) This parameter is only available if the Operation parameter (above) is set to Clear.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Remove User From Group removes a user from a group.

User Distinguished Name (DN)

Enter the user distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Group Distinguished Name (DN)

Enter the group distinguished name in LDAP. If the DC (domain context) is not specified in the DN, it will be taken from the resource DC.

Error Code

This parameter is returned, with the corresponding error code, when an error occurs.

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Related Topics

Reference
Attachment 
Attachment