Update Ldap provider.

put

https://cluster.ip.address/v2/ldap

Privileges: AD_LDAP_MODIFY

Modify Ldap provider with given parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to update Ldap provider.

adDomainName

string | null

Specifies the domain name of an Active Directory which is mapped to this LDAP provider

attributeCommonName

string | null

Specifies name of the LDAP attribute used for common name of an object.

attributeGid

string | null

Specifies name of the attribute used to lookup unix GID of an LDAP user.

attributeMemberOf

string | null

Specifies name of the LDAP attribute used to lookup members of a group.

attributeUid

string | null

Specifies name of the attribute used to lookup unix UID of an LDAP user.

attributeUsername

string | null

Specifies name of the LDAP attribute used to lookup a user by user ID.

authType

string

enum

required

Specifies the LDAP authentication type.

Allowed:

baseDistinguishedName

string | null

required

Specifies the base distinguished name used as the base for LDAP search requests.

domainName

string | null

Specifies the name of the domain name to be used for querying LDAP servers from DNS.

name

string | null

required

Specifies the LDAP name.

objectClassGroup

string | null

Specifies name of the LDAP group object class for user accounts.

objectClassUser

string | null

Specifies name of the LDAP user object class for user accounts.

port

int32 | null

Specifies the LDAP server port.

preferredLdapServers

array of strings | null

Specifies a list of preferred LDAP servers. Servers should either be FQDNs or IP addresses.

preferredLdapServers

simpleAuthParams

object

Specifies the parameters for LDAP with 'Simple' authentication type.

int64 | null

Specifies the LDAP id.

tenantId

string | null

Specifies the LDAP tenant id.

200Success

defaultError