Versions Compared

Old Version 25

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 26

changes.mady.by.user Lakshmi Manda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write


Description:

 This Snap adds an existing member to an existing specified group name in Active Directory.

  • Expected upstream Snaps: File Reader followed by any file Parser, followed by Structure.
  • Expected downstream Snaps: Any file Formatter followed by File Writer.
  • Expected input: Distinguished name, Group name
  • Expected output:  The status of whether the distinguished name is added to the entered group name or not.


Prerequisites:

[None]


Support and limitations:

Works in Ultra Task Pipelines.

Account: 

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.


Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


Required. 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.

Distinguished name


Required. 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]

Note

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


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

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

Default value: [None]


Note
When adding a member to 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

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

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute


Multiexcerpt macro
nameAdditional Information

Additional Information

User-Agent Header

The Azure Active Directory Snap Pack utilizes the REST HTTP Client to send HTTP requests to the Azure endpoint. This process incorporates a User-Agent header with the value of "SnapLogic" for every request. By including the User-Agent header, you can monitor and track the requests made to the Azure endpoint, allowing you to determine the total count of requests made.

To view the User-Agent number for a user or group:

  1. Log in to the Azure portal.

  2. Navigate to Azure services > Azure Active Directory.

  3. Navigate to Users/Groups and select the desired User/Group.

  4. Click Audit logs in the left navigation menu.
    In the right pane, you can view the User-Agent number in the following format:
    SnapLogic (<build_number>) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd. For example, a PR build might have SnapLogic (PR21312) - pid-113e3955-1969-4541-9c9c-e3e0c897cccd as the User Agent
    The pid value comes from Microsoft®.

Example

Excerpt

Using Special Characters in Distinguished Name

You can include special characters in the Distinguished name and Existing distinguished name fields. As of Patch activedirectory8789, the fields do not require the following special characters to be prefixed with an escape character:

  • Forward slash (/)
  • Backward slash (\)
  • Plus (+)
  • Double-quote (")
  • Less than symbol (<)
  • Greater than symbol (>)
  • Semi-colon (;)

If an escape character is prefixed, the Snap reads it, else, it prefixes it to the special character to correctly process the data.

Info

Comma (,) and Equals (=) have a special meaning in the distinguished name, as comma (,) is used to separate RDNs and equals (=) is used for designating key value pairs (key=value). Therefore, these must still be prefixed with an escape character to be passed as special characters. For example, \, or \=.

Example: Using Special Characters

Let us say you need to specify a distinguished name like CN=man/eesh,CN=Users,DC=ad1,DC=clouddev,DC=snaplogic,DC=com, where the common name man/eesh contains a special character. 

The Snap supports both scenarios:   

  • If the special character is prefixed with an escape character. For example, CN=man\/eesh. 
  • If no escape character is used. For example, CN=man/eesh,

In both cases, the Snap generates the same output during Pipeline validation, as shown in the image below. This ensures existing Pipelines do not break in either case.

Image Modified

Note
titleUsing the pass-through functionality

In certain scenarios, the Snap may be unable to process the entire input due to limitations imposed by the endpoint's API. In such cases, we recommend that you select the Pass through checkbox to ensure that the unprocessed input is not lost. You can process the remaining input data using more of the same Snap in the Pipeline. Alternatively, you can also write the original data into a separate file using a combination of the Mapper Snap and the File Writer Snap. 



Insert excerpt
Active Directory Snap Pack
Active Directory Snap Pack
nopaneltrue