Active Directory Update User Photo

Overview

The Active Directory Update User Photo Snap updates the user photo in the Active Directory to the provided distinguished name.

Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Expected input: Distinguished name, Photo attribute name, Base64 jpeg string.

Output

This Snap has exactly one document output view.

Expected output: A document containing the updated distinguished name.

Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Active Directory Update User Photo

Distinguished name

String/Expression

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 Active Directory Create Entry Snap first.

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

Default value: None

You can also use special characters in the distinguished name. See using special characters in Distinguished Name.

Photo attribute name

String/Expression

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

Default value: jpegPhoto

Base64 jpeg string

String/Expression

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

Pass through

Checkbox

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

Note: 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, select this 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, or write the original data into a separate file using a combination of the Mapper Snap and the File Writer Snap.
Snap execution

Dropdown list
Choose 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.