createDirectoryProvider

Summary

Creates a new Active Directory or LDAP directory provider.

providerName

Stringrequired

Name for a LDAP directory provider; must be unique.

allowNestedGroupsApprovers

Booleanoptional

Specifies if users in nested LDAP groups should be allowed to approve a manual task when a parent LDAP group is assigned as an approver for the task and recursive traversal of group hierarchy is enabled for the directory provider.

commonGroupNameAttribute

Stringoptional

The attribute in a group record that contains the common name of the group. If specified, it is only used when searching for groups from an external provider. Typically used when the group name attribute is set to distinguishedName, because that field is not searchable.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

domainName

Stringoptional

The domain from which the Active Directory server(s) are automatically discovered.

emailAttribute

Stringoptional

The attribute in a LDAP user record that contains the user's email.

enableGroups

Booleanoptional

Determines whether or not to enable external groups for the directory provider.

fullUserNameAttribute

Stringoptional

The attribute in a user record that contains the user's full name (first and last).

groupBase

Stringoptional

String prepended to the base distinguished name to construct the distinguished name of the directory that contains group records.

groupMemberAttributes

Stringoptional

Comma separated list of attribute names that can identify a member of a group.

groupMemberFilter

Stringoptional

LDAP query string for the groups directory to find groups that contain a given user as a member.

groupNameAttribute

Stringoptional

The attribute in a group record that contains the name of the group.

groupSearchFilter

Stringoptional

LDAP query string used in group directory to enumerate group records.

managerDn

Stringoptional

The name of a user who has read-only access to the LDAP or Active Directory server. Typically a distinguished name. A simple name may be used when the Active Directory server's URL is being auto-discovered via DNS.

managerPassword

Stringoptional

Secret value used to identify the account for the query user.

membershipAttribute

Stringoptional

Attribute defined on an LDAP user or group entry used by the LDAP provider for specifying the group membership.

membershipFilter

Stringoptional

LDAP filter to search for groups that an LDAP user or group belongs to.

nestedGroupDepthLimit

Integeroptional

Maximum number of group hierarchy levels that will be traversed for retrieving nested group membership information.

notifyUsersInNestedGroups

Booleanoptional

Whether users in nested LDAP groups should be included when sending notifications for a parent LDAP group and recursive traversal of group hierarchy is enabled for the directory provider.

providerType

Stringoptional

Type string for a directory provider. Should be ldap or activedirectory.

Possible values: "CYBERARK", "HASHICORP"

realm

Stringoptional

The realm of the LDAP directory provider. This is used to create unique user names when there are multiple providers.

traverseHierarchy

Booleanoptional

Whether or not to enable recursive traversal of group hierarchy for nested group membership information.

url

Stringoptional

The URL of the LDAP Directory Provider server. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].

useSSL

Booleanoptional

True means SSL is used for communication.

userBase

Stringoptional

Used to construct the distinguished name of the directory that contain user records.

userNameAttribute

Stringoptional

The attribute in a user record that contains the user's account name.

userSearchFilter

Stringoptional

RFC 2254 LDAP query to search for a user by name.

userSearchSubtree

Booleanoptional

If true recursively search the subtree below the user base.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createDirectoryProvider(
  providerName: "test-providerName"
  /* optional arguments */
)▼