Input 

Document

• Min: 0

• Max: 1

• Mapper

A document containing the details of the member to be removed.

Output

Document

• Min: 1

• Max: 1

• Copy

A confirmation message about the removed member.

Label*

String

N/A

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default Value: Remove Member
Example: Remove Member

Distinguished name*

String

N/A

The LDAP API references an LDAP object by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. An RDN is an attribute with an associated value in the form attribute=value, normally expressed in a UTF-8 string format.  The typical RDN attribute types include: 

DC = domainComponent, CN = commonName, OU = organizationalUnitName,O = organizationName, STREET = streetAddress, L = localityName,ST = stateOrProvinceName, C = countryName, UID = userid.

This field is applicable only to existing users. If the user does not exist, create an entry using the Create Entry Snap first.

Example: A distinguished name for an LDAP entry can be represented as: 

CN=AbcUser,CN=Users,DC=server,DC=company,DC=com. 

In this example, to refer to the entire user list, you can remove the initial attribute, CN=AbcUser.

Default value: [None]

Group name*

String

N/A

The name of the group as RDN (Relative distinguished name) in which you would like to remove the user.

Example: CN=DemoGroup,CN=Users,DC=server,DC=company,DC=com

Default value: [None]

Pass through

N/A

Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output. 

Default value: Not selected

Snap Execution

Dropdown

N/A

Select one of the three following modes in which the Snap executes:

• Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled. Disables the Snap and all Snaps downstream from it.

Default Value: Execute Only
Example: Validate & Execute

Cannot remove the member

Error while removing the member from the group. Entered values are invalid.

Please verify the entered values for the distinguished name and group are valid.