Update Ldap provider.

put

https://helios.cohesity.com/v2/ldap

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.

name

string | null

required

Specifies the LDAP name.

preferredLdapServers

array of strings | null

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

preferredLdapServers

domainName

string | null

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

baseDistinguishedName

string | null

required

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

authType

string

enum

required

Specifies the LDAP authentication type.

Allowed:

port

int32 | null

Specifies the LDAP server port.

simpleAuthParams

object | null

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

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.

attributeUid

string | null

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

attributeMemberOf

string | null

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

attributeUsername

string | null

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

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.

int64 | null

Specifies the LDAP id.

tenantId

string | null

Specifies the LDAP tenant id.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError