Skip to main content

Create LDAP/Active directory for user authentication​

Select

SaaS
Customer Managed

Create LDAP/Active directory for user authentication

Request Body

LDAP body request

  • directoryType string required

    Possible values: [ACTIVE_DIRECTORY]

    Active directory type

  • NETBIOSName string required

    Domain name (short name) to create LDAP app

  • name string required

    Domain connect name

  • useSecureLDAP boolean

    Boolean to indicate if the app use secure LDAP

  • enableSSO boolean

    Boolean to indicate if the app use enable SSO

  • globalConfigInfo object

    Only applicable to Global CommCells. Not applicable for SaaS.

  • name string
  • commcells object[]

    List of Service CommCells where the global configuration should be applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config has to be applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string using for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • actionOnLocalEntity string

    Possible values: [CREATE_NEW, TAKE_OVER, FAIL_IF_EXIST]

    Action that will be taken on the local entity that has the same name as the global entity that needs to be created

  • id int32

    Required when configuring an existing dummy domain as LDAP/AD

  • username string required

    Username to create LDAP/AD app

  • password base64 required

    Password to create LDAP app, it should be base64 encoded

  • accessViaClient boolean

    Denotes if the domain is accessed via a proxy

  • proxies object[]

    List of proxies used to connect to the domain. Required if accessViaClient is true.

  • id int32
  • name string
  • doNotValidateNetBIOSName boolean

    If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
POST /v4/ldap

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "directoryType": "ACTIVE_DIRECTORY",

  "NETBIOSName": "string",

  "name": "string",

  "useSecureLDAP": true,

  "enableSSO": true,

  "globalConfigInfo": {

    "name": "string",

    "commcells": [

      {

        "id": 0,

        "name": "string",

        "guid": "string"

      }

    ],

    "scope": "string",

    "scopeFilterQuery": "string",

    "applyOnAllCommCells": true,

    "actionOnLocalEntity": "CREATE_NEW"

  },

  "id": 0,

  "username": "string",

  "password": "string",

  "accessViaClient": true,

  "proxies": [

    {

      "id": 0,

      "name": "string"

    }

  ],

  "doNotValidateNetBIOSName": true

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/LDAP' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "directoryType": "ACTIVE_DIRECTORY",
  "NETBIOSName": "string",
  "name": "string",
  "useSecureLDAP": true,
  "enableSSO": true,
  "globalConfigInfo": {
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "actionOnLocalEntity": "CREATE_NEW"
  },
  "id": 0,
  "username": "string",
  "password": "string",
  "accessViaClient": true,
  "proxies": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "doNotValidateNetBIOSName": true
}'