Active Directory Remove Member

 

In this article

Overview

You can use this Snap to remove an existing member from a specified group in Active Directory. This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Active Directory Basic Auth Account for information on setting up this type of account.

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

None.

Views

Type of View

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type of View

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

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.

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

Field Name

Field Type

Field Dependency

Description

Field Name

Field Type

Field Dependency

Description

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 ValueRemove Member
ExampleRemove 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]

You can also use special characters in the Distinguished name field with the exception of forward slash "/". See the section Using Special Characters in Distinguished Name below.

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]

When removing a member from a group, make sure that the member and the group already exist. Members and groups can be created by the Create Entry Snap.

Pass through

Checkbox

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 ValueExecute Only
ExampleValidate & Execute

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

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.


See Also

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1437988

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438548

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary