Get Involved
Edit on GitHub

UpdateLdapDirectoryInput

UpdateLdapDirectoryInput

Input type to update an LDAP directory

baseStringOptional base DN of the LDAP directory to connect to
connectivityTestFilterStringOptional connectivityTestFilter of the LDAP directory to store a test filter to be used by the connectivity control for testing LDAP connections.
descriptionStringOptional description of the LDAP directory to update
disabledGroupFilterStringOptional disabledGroupFilter of the LDAP directory to filter out disabled groups in the LDAP server. If not specified then (description=disabled) is used.
disabledUserFilterStringOptional disabledUserFilter of the LDAP directory to connect to. If not specified then !(userAccountControl:1.2.840.113556.1.4.803:=2) is used
distinguishedNameStringOptional distinguishedName of the LDAP directory account to connect as
groupCanonicalNameAttributeStringOptional groupCanonicalNameAttribute of the LDAP directory to connect to. If not specified then cn is used
groupMemberOfAttributeStringOptional groupMemberOfAttribute of the LDAP directory to store the attribute name where parent groups of a group/user are stored.
groupMembershipAttributeStringOptional groupMembershipAttribute of the LDAP directory to store the attribute name where member groups/users of a group are stored.
groupObjectFilterStringOptional groupObjectFilter of the LDAP directory to connect to. If not specified then (objectCategory=group) is used
groupSearchFilterStringOptional groupSearchFilter of the LDAP directory to connect to. The provided filter is Nunjucks rendered with groupname provided as a data parameter. If not specified then `(
groupSyncFilterStringOptional groupSyncFilter of the LDAP directory to connect to. This filter will find groups to sync, subject to the base and groupObjectFilter.
idID!The id of the LDAP directory to update, either as an id, or an AKA
passwordStringOptional password of the LDAP directory account to connect as
rejectUnauthorizedBooleanOptional rejectUnauthorized of the LDAP directory indicating whether unauthorized LDAP server requests should be rejected or not.
statusDirectoryStatusOptional status of the LDAP directory to update
tagsScalarOptional tags for the LDAP directory to update
titleStringOptional title of the LDAP directory to update
tlsEnabledBooleanOptional tlsEnabled of the LDAP directory indicating whether server side TLS encryption is enabled for the LDAP Connection.
tlsServerCertificateStringOptional tlsServerCertificate of the LDAP directory to store the root certificate for TLS encryption.
urlStringOptional url of the LDAP directory to connect to
userCanonicalNameAttributeStringOptional userCanonicalNameAttribute of the LDAP directory to connect to. If not specified then cn is used
userDisplayNameAttributeStringOptional userDisplayNameAttribute of the LDAP directory to connect to. If not specified then displayName is used
userEmailAttributeStringOptional userEmailAttribute of the LDAP directory to connect to. If not specified then mail is used
userFamilyNameAttributeStringOptional userFamilyNameAttribute of the LDAP directory to connect to. If not specified then sn is used
userGivenNameAttributeStringOptional userGivenNameAttribute of the LDAP directory to connect to. If not specified then givenName is used
userMatchFilterStringOptional userMatchFilter of the LDAP directory to connect to.
userObjectFilterStringOptional userObjectFilter of the LDAP directory to connect to. If not specified then (objectCategory=user) is used
userSearchAttributes[String!]Optional userSearchAttributes of the LDAP directory to connect to. If not specified then this defaults to ["*"]. If attributes other than "*" are specified, then additionally the values for userDisplayNameAttribute and userAccountNameAttribute are included
userSearchFilterStringOptional userSearchFilter of the LDAP directory to connect to. The provided filter is Nunjucks rendered with username provided as a data parameter. If not specified then `(