Update an Active Directory.

put

https://helios.cohesity.com/v2/active-directories/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies id of an Active Directory.

Body Params

Request to update an Active Directory.

machineAccounts

array of objects | null

required

Specifies a list of computer names used to identify the Cohesity Cluster on the Active Directory domain. The first machine account is used as primary machine account and it can not be modified.

machineAccounts*

name

string | null

required

Specifies the machine account name.

dnsHostName

string | null

Specifies the DNS host name of the machine account.

encryption

array of strings | null

Specifies a list of encryption types apply to the machine account.

servicePrincipalNames

array of strings | null

Specifies the customized Service Principal Names of the Machine Account. Service Principal Name should be unique across the Active Directory forest.

servicePrincipalNames

organizationalUnitName

string | null

Specifies an optional organizational unit name.

workGroupName

string | null

required

Specifies a work group name.

preferredDomainControllers

array of objects or null | null

Specifies a list of preferred domain controllers of this Active Directory.

preferredDomainControllers

domainControllersDenyList

array of strings or null

Specifies a list of denied domain controllers of this Active Directory Domain.

domainControllersDenyList

ldapProviderId

int64 | null

Specifies the LDAP provider id which is mapped to this Active Directory

trustedDomainParams

object | null

Specifies the params related to trusted domains.

nisProviderDomainName

string | null

Specifies the name of the NIS Provider which is mapped to this Active Directory.

connectionId

int64 | null

Specifies the id of the connection.

activeDirectoryAdminParams

object | null

Specifies the params of a user with administrative privilege of an Active Directory.

overwriteMachineAccounts

boolean | null

Specifies if specified machine accounts should overwrite existing machine accounts.

idMappingParams

object | null

Specifies the params of the user id mapping info of an Active Directory.

transitiveAdTrustLevelLimit

int32 | null

Specifies level of transitive Active Directory trust domains to be used.

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