Active Directory Update User Photo

On this Page

Snap type:

Write


Description:

This Snap updates the user photo in the Active Directory to the provided distinguished name.

  • Expected upstream Snaps: Upstream Snap can be given. File reader followed by any file parser  followed by Structure.
  • Expected downstream Snaps: Any file  Formatter followed by File Writer.
  • Expected input:  Distinguished name, Photo attribute name,  Base64 jpeg string
  • Expected output:  This Snap will display the updated distinguished name.


Prerequisites:

[None]


Support and limitations:Works in Ultra 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.

ExampleA 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. See the section Using Special Characters in Distinguished Name below.


Photo attribute name

Required. The name of the photo attribute in Active Directory to update. This defaults to 'jpegPhoto' but can be customized within Active Directory.


Base64 jpeg string

Required. Provide the base64 jpeg string of the image to be uploaded.


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

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, 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 that are downstream from it.

Example

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.

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.

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

Snap Pack History

 Click to view/expand
Release
Snap Pack Version 
Date
Type
Updates
February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.
August 2023434patches23465 LatestFixed an issue with the Update Entry Snap that caused a null pointer exception when both a delimiter was provided and the attribute value was set to null.
August 2023main22460 StableUpdated and certified against the current SnapLogic Platform release.
May 2023433patches21612 Latest

Fixed the following issues with the Active Directory Update Entry Snap where the Snap produced incorrect results with the version main21015:

  • When set to null, all the string attributes were updated with the literal "null" string instead of an empty string.

  • The Snap failed with javax.naming.directory.InvalidAttributeValueException error when all the number-type attributes were set to null.

May 2023main21015 StableUpgraded with the latest SnapLogic Platform release.
February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main18944 Stable

Upgraded with the latest SnapLogic Platform release.

September 2022430patches17872 Latest

The Azure Directory Search Snap doesn't fetch duplicate records when the Group result checkbox is not enabled.

August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableAdded the Active Directory Remove Member Snap that enables you to remove an existing member from a specified group in Active Directory.
4.27main12833StableEnhanced the Active Directory Search Snap with a new fieldset, Returning Attributes, to define attributes that you want the Snap to return in the search results.
4.26 Patch426patches11280 LatestFixed an issue with the Active Directory Add Member Snap that failed when using forward slash "/" in the Distinguished name field.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554 StableUpgraded with the latest SnapLogic Platform release.
4.24main8556 StableUpgraded with the latest SnapLogic Platform release.
4.23 Patch423patches8210 Latest

Fixes an issue of fetching search records in the Active Directory Search Snap by adding a new field, Limit, to specify the number of search records to be fetched from the Active Directory.

  • Previously the Page Size field worked similar to the Limit field, that is, it sets the limit on fetching records instead of fetching all the records. 
  • The Active Directory Search Snap output now displays the number of records that you specify in the Limit field under Settings. If your Pipelines use the Snap with the Page Size field, they may fail to execute if the downstream Snap expects the same count. To retrieve all the records, configure the Snap with default settings, that is, Limit: 0 and Page Size: 1000.
4.23 Patch423patches7454 Latest

Adds the Pass through check box in all the Snaps to include pass-through functionality. Select this check box to embed the upstream input documents under the original field of the output document along with other records.

4.23main7430 Stable
4.22422patches6531

 


Latest

Enhances the Active Directory Create Entry and Active Directory Update Entry Snaps by adding Attribute Value Delimiter field to separate multiple values entered in the Attribute value field.

4.22main6403 StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542 StableUpgraded with the latest SnapLogic Platform release.
4.20 Patchactivedirectory8789 Latest

Fixes the Active Directory Snaps to successfully read special characters in the Existing distinguished name and Distinguished name Snap settings without requiring escape characters.

4.20snapsmrc535 Stable

Fixes the Search Snap and the List Users Snap wherein the Snaps displayed only the first element of an array field. Now, the Snaps display all the elements of an array field.

4.19 Patch activedirectory8506 Latest

Fixes the Search Snap and the List Users Snap wherein the Snaps displayed only the first element of an array field. Now, the Snaps display all the elements of an array field.

4.19snapsmrc528 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523 Stable Upgraded with the latest SnapLogic Platform release.
4.17 PatchALL7402
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17 snapsmrc515 Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 snapsmrc508 StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500 StableUpgraded with the latest SnapLogic Platform release.
4.14 snapsmrc490 StableUpgraded with the latest SnapLogic Platform release.
4.13snapsmrc486 StableUpgraded with the latest SnapLogic Platform release.
4.12snapsmrc480 StableUpgraded with the latest SnapLogic Platform release.
4.11 Patch activedirectory4630 Latest

Resolved an issue with the Active Directory Search Snap that Ignored PartialResultException and did not handle the slashes and backslashes in the search function:

  • Added the original exception to SnapdataException for the Active Directory Snaps.
  • Improved the error message.
4.11snapsmrc465

 

StableUpgraded with the latest SnapLogic Platform release.
4.10snapsmrc414 StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405 StableUpgraded with the latest SnapLogic Platform release.
4.8snapsmrc398 StableUpgraded with the latest SnapLogic Platform release.
4.7snapsmrc382 StableUpgraded with the latest SnapLogic Platform release.
4.6 Patch activedirectory2056 Latest

Resolved an issue with modifying the "unicodePwd" attribute using the Active Directory - Update Entry Snap.

4.6rcmsf233 Stable
  • Extended support for a der encoded representation of Anaplan Certificate for Anaplan account validation.
  • Resolved an issue in Create Entry, Search, and Update Entry Snaps that caused certain attributes to not appear in suggestions.
4.5.1rcmsf231 StableUpgraded with the latest SnapLogic Platform release.
4.5rcmsf231

 

StableUpgraded with the latest SnapLogic Platform release.
4.3.2

Stable

Resolved an issue in Active Directory Search resulting in an error using a port value in the server URI.

4.3.0



Stable

The Update Snap now populates all attributes during Suggest. The Search Snap now shows those attributes that have values.

4.2.2

Stable
  • Resolved an issue with the account failing to validate after the last Snap release.
  • Resolved an issue with the Active Directory Search Snap failing to throw an exception for an invalid search.
  • Resolved an issue with the Active Directory Search Snap not routing an error to the error view for a null search.
  • Resolved an issue with the Active Directory Search Snap adding a blank space on all strings.
  • Updated the tooltips within the Active Directory Snap Pack.
4.2.1

Stable

Resolved "Pass through only supported for Map data." message showing in Active Directory Rename Snap.