In this article
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.
Valid client ID.
A valid account with the required permissions.
Works in Ultra Pipelines.
None.
None.
Type of View | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing the details of the member to be removed. |
Output | Document |
|
| A confirmation message about the removed member. |
Field names marked with an asterisk ( * ) are mandatory. |
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 Value: 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 | 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:
Default Value: Execute Only |
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. |
Provide links to the endpoint's official documentation, any relevant or related internal documentation, and any other links you have referred to on this page. Care should be taken when referencing external sites/documentation that it is an official site/documentation. Do not refer to forums such as stackoverflow.
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary