LDAP query component

Table of Contents

Description

Makes a request to the directory service server using the protocol LDAP.

Table 1. System Characteristics

Index

142

Short title

ldap

Types of scenarios

All of them

Starter module

r_script_component_ldap

Mode

Asynchronous

Icon

142

Branching pattern

Branching, closing

Properties

Table 2. Properties
Specification Description

Title: Protocol
Code: proto
Visibility: no
Default: LDAP

Server connection protocol.
Possible options:

  • LDAP (ldap, 0)

  • LDAPS (ldaps, 1)

Title: Server Addresses
Code: hosts
Visibility: no
Default: — 

List of directory service server addresses.

As a string where addresses are separated by any character: comma, semicolon, space, tab, end of line.
Domain names, ip addresses, and URIs from which the domain name will be pulled may be specified.

A connection will be attempted with a brute force search of all addresses to end or succeed.

Title: Port
Code: port
Visibility: no
Default: — 

Port to connect to servers. Default is 389 for LDAP, 636 for LDAPS.

Title: Certificate
Code: cert
Visibility: no
Default: — 

For SSL/TLS connection points points to the certificate PEM file located in the ':SYNC_DOMAIN' directory or ':SYNC_COMMON'.
The certificate file can be downloaded, for example, to the REST-endpoint '/rest/v1/fs/targets/files/certificates/cert.pem' and addressed via the ':SYNC_DOMAIN_DATA/files/certificates/cert.pem'.

Applies when switching LDAP to TLS, and also in LDAPS.
If not specified, the client connection will not check the server certificate for trust.

Title: User Domain
Code: domain
Visibility: no
Default: — 

Authorization parameter: domain.
For example, Siberia.ttt

Title: User Name
Code: login
Visibility: no
Default: — 

Authorization parameter: login.

Title: Password
Code: password
Visibility: no
Default: — 

Authorization parameter: password.

Title: Timeout, s
Code: timeoutSec
Visibility: no
Default: — 

Timeout to wait for operation execution, in seconds.

Title: Action
Code: actionLdap
Visibility: no
Default: `Authorize'

Options for Directory Service operations.
Possible options:

  • Authorize (auth, 0) - Simple check if the directory is available and if the authorization data is correct.

  • Find (search, 1) - Search the directory service for the specified string and required parameters.

  • Create (add, 2) - Create an object in the specified directory service domain.

  • Delete (delete, 3) - Deletes an object in the specified directory service domain.

  • Modify (modify, 4) - Create an object in the specified directory service domain.

  • Change Password (modify_pwd, 5) - Change the account password.

  • Modify DN (modify_dn, 6) - Change the domain name.

Name: DN
Code: dn
Visibility: yes
Default: — 

The name of the domain in which the operation is performed.
Applies to all actions except Authorize.

For example, ou=AD-TEST,dc=Siberia,dc=ttt

Title: Scope
Code: scope
Visibility: yes
Default: The whole branch'', Select the scope for the search operation.
Applies to the action Find.
Possible options:

  • Baseobject (baseobject, 0) - Inside object only.

  • Level only (siglelevel, 1) - By the specified level of the list, that is, without recursion.

  • Whole Branch (wholesubtree, 2) - Across the entire child tree.

Title: Attributes
Code: attributes
Visibility: yes
Default: — 

Attributes to search for.
Applies to the action Find.

For example, objectGUID,cn,telephoneNumber,mobile.

Title: Search string
Code: filter
Visibility: yes
Default: — 

Directory service search string.
Applies to the action Find.

For example, present("cn") and present("telephoneNumber") and present("objectGUID") and substrings("mobile",5551234)

Title: Attributes
Code: attrs
Visibility: yes
Default: — 

Attributes of the new or modified element.
Applies to Create and Modify actions`.

Title: New Password
Code: newpwd
Visibility: yes
Default: — 

New Password.
Applies to the Change password' action.

Title: Old Password
Code: oldpwd
Visibility: yes
Default: — 

Old password used for validation when changing.
Applies to the Change password' action.

Title: New DN
Code: newdn
Visibility: yes
Default: — 

New name for the item.
Applies to the Edit action DN.

Title: Parental DN
Code: newsupdn
Visibility: yes
Default: — 

Parent element.
Applies to the Edit action DN.

Title: Result to variable
Code: resultVar
Visibility: no
Default: — 

Variable to save the result of the operation.

Title: Error code to variable
Code: errorVar
Visibility: no
Default: — 

Variable to store the error code.

Title: Transition, Success
Code: transfer
Visibility: no
Default: — 

The component to which control is passed if the operation is successfully completed.

Title: Transition, Error
Code: transferError
Visibility: no
Default: — 

See also