Bind | View Rest API

Bind

All the listed privileges are required -

Privileges	Description
GLOBAL_CONFIG_MANAGEMENT	Caller should have permission to this privilege, to perform this operation.

Request

URI

POST

https://{api_host}/rest/external/v1/ad-domains/action/bind

COPY

Request Body

ADDomainSpec of type(s) application/json

Required

Show optional properties

{
    "ad_domain_advanced_settings": {
        "ad_domain_context": "dc=abc,dc=com",
        "port": 389
    },
    "dns_name": "example.com",
    "netbios_name": "EXAMPLE",
    "primary_account": {
        "password": [
            {}
        ],
        "username": "Administrator"
    }
}

{
    "ad_domain_advanced_settings": {
        "ad_domain_auto_discovery": true,
        "ad_domain_context": "dc=abc,dc=com",
        "ad_domain_controllers": [
            "example.com",
            "example1.com"
        ],
        "ad_domain_preferred_site": "Bengaluru",
        "port": 389
    },
    "dns_name": "example.com",
    "netbios_name": "EXAMPLE",
    "primary_account": {
        "password": [
            "<password>"
        ],
        "username": "Administrator"
    }
}

object

ad_domain_advanced_settings

Required

Information related to untrusted Domain advance settings.

string As ^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)+[A-Za-z0-9]{2,63}$

dns_name

Required

The DNS name of the domain.

string

netbios_name

Required

The NetBIOS name of the domain.

object

primary_account

Required

Information related to untrusted Domain service accounts.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Created

Returns ADDomainBindInfo of type(s) */*

"ADDomainBindInfo Object"

string

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"ad_domain_advanced_settings:"object","dns_name:"string","netbios_name:"string","primary_account:"object"}' https://{api_host}/rest/external/v1/ad-domains/action/bind

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

External Operations

GET

List AD Domains

POST