Bind

Bind

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

All the listed privileges are required -

Privileges Description
GLOBAL_CONFIG_MANAGEMENT Caller should have permission to this privilege to configure and manage untrusted domain.
Request
URI
POST
https://{api_host}//localhost/rest/external/v1/ad-domains/action/bind
COPY
Request Body

Specification of untrusted domain.

ADDomainSpec of type(s) application/json
Required 
{
    "ad_domain_advanced_settings": {
        "ad_domain_auto_discovery": true,
        "ad_domain_context": "dc=abc,dc=com",
        "ad_domain_controllers": [
            "string"
        ],
        "ad_domain_preferred_site": "Bengaluru",
        "port": 389
    },
    "dns_name": "example.com",
    "netbios_name": "EXAMPLE",
    "primary_account": {
        "password": [
            "string"
        ],
        "username": "Administrator"
    }
}
ADDomainAdvancedSettings
ad_domain_advanced_settings
Optional

ad_domain_advanced_settings

string
dns_name
Required

The DNS name of the domain.

string
netbios_name
Required

The NetBIOS name of the domain.

ServiceAccountCredentials
primary_account
Optional

primary_account

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns ADDomainBindInfo of type(s) */* 
{
    "id": "S-1-5-21-3861703653-2745738756-3849765893"
}
string
id
Optional

Unique ID representing the AD domain.


400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict

Operation doesn't return any data structure

On This Page
External Operations
POST
Bind
POST
Change User Password
POST
Compute Space Requirements
GET
Get AD User Or Group Info
GET
List AD Domains
GET
List AD Domains V2
GET
List AD User Or Group Summary
GET
List Base Snapshots
GET
List Base V Ms
GET
List Customization Specs
GET
List Datacenters
GET
List Datastore Clusters
GET
List Datastore Paths
GET
Listdatastores
GET
List Hosts Or Clusters
GET
List Network Interface Cards
GET
List Network Labels
GET
List Resource Pools
GET
List Virtual Machines
GET
List VM Folders
GET
List VM Templates
POST
Unbind
POST
Update
POST
Validate AD User Encrypted Credentials