Join the Cohesity Cluster to the specified Active Directory.

post

https://cluster.ip.address/irisservices/api/v1/public/activeDirectory

Privileges: AD_LDAP_MODIFY

After a Cohesity Cluster has been joined to an Active Directory domain,
the users and groups in the domain can be authenticated on the Cohesity Cluster
using their Active Directory credentials.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to join an Active Directory.

domainName

string | null

Specifies the fully qualified domain name (FQDN) of an Active Directory.

fallbackUserIdMappingInfo

object | null

Specifies the fallback id mapping info which is used when an ID mapping
for a user is not found via the above IdMappingInfo. Only supported for
two types of fallback mapping types - 'kRid' and 'kFixed'.

forceRemove

boolean | null

Specifies if Active Directory entry should be force removed from cluster.

ignoredTrustedDomains

array of strings | null

Specifies the list of trusted domains that were set by the user to be
ignored during trusted domain discovery.

ignoredTrustedDomains

ldapProviderId

int64 | null

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

machineAccounts

array of strings | null

Array of Machine Accounts.

Specifies an array of computer names used to identify the Cohesity
Cluster on the domain.

machineAccounts

onlyUseWhitelistedDomains

boolean | null

Specifies whether to use 'whitelistedDomains' only for authentication.

ouName

string | null

Specifies an optional Organizational Unit name.

overwriteExistingAccounts

boolean | null

Specifies whether the specified machine accounts should overwrite the
existing machine accounts in this domain.

password

string | null

Specifies the password for the specified userName.

preferredDomainControllers

array of objects | null

Specifies Map of Active Directory domain names to its preferred domain
controllers.

preferredDomainControllers

taskPath

string | null

Specifies the task path for AD joining task.

tenantId

string | null

Specifies the unique id of the tenant.

trustedDomainsEnabled

boolean | null

Specifies whether Trusted Domain discovery is disabled.

unixRootSid

string | null

Specifies the SID of the Active Directory domain user to be mapped to
Unix root user.

userIdMappingInfo

object | null

Specifies the information about how the Unix and Windows users are mapped
for this domain.

userName

string | null

Specifies a userName that has administrative privileges in the domain.

whitelistedDomains

array of strings | null

Specifies the Whitelisted Domains of the Active Directory domain.

whitelistedDomains

workgroup

string | null

Specifies an optional Workgroup name.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError