Get AD/LDAP Details

Select

SaaS

Customer Managed

Get detail of the AD/LDAP domain

Path Parameters

• domainId int32 required

  ID of the AD/LDAP domain

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Active Directory
• Apple Directory Service
• L D A P Server
• Open L D A P
• Oracle Directory

---

Schema

• id int32
• name string
• domainName string

  Domain to which the users are associated

• directoryType string

  Possible values: [ACTIVE_DIRECTORY, APPLE_DIRECTORY_SERVICE, LDAP_SERVER, OPEN_LDAP, ORACLE_DIRECTORY, OTHER]

  Directory type of an AD/LDAP domain

• credentials string

  Username of the domain user used to connect to the domain

• company object

  id int32

  name string
• users int32

  Number of users in the domain

• userGroups int32

  Number of user groups in the domain

• baseDNForCardUsers string

  Base DN for card users. Available only if domainType is ACTIVE_DIRECTORY.

• useSecureLDAP boolean

  Boolean to indicate if the identity server uses secure LDAP

• enableSSO boolean

  Denotes if SSO is enabled

• accessViaClient boolean

  Denotes if the domain is accessed via a proxy

• proxies object[]

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

  id int32

  name string
• LDAPQueryParameters object[]

  List of query parameters for the LDAP domain. Available only if the directory type is LDAP_SERVER

  id int32

  ID of the attribute

  name string

  Name of the attribute

  value string

  Current value of the attribute

  defaultValue string

  Default value of the attribute

  isOverridden boolean

  Denotes if the value of the attribute is overridden

• attributeMap object[]

  List of attribute mappings for the LDAP domain. Available only if the directoryType is LDAP_SERVER.

  id int32

  ID of the attribute

  name string

  Name of the attribute

  value string

  Current value of the attribute

  defaultValue string

  Default value of the attribute

  isOverridden boolean

  Denotes if the value of the attribute is overridden

• globalConfigInfo object

  Only applicable on Global CommCells

  id string

  name string

  commcells object[]

  List of Service CommCells where the global configuration is applied

  id int32

  name string

  guid string

  scope string

  The entity level at which the config is applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string used for filtering the scope

  applyOnAllCommCells boolean

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

  isMarkedForDeletion boolean

  Indicates whether global configuration deletion has been started.

  status string

{
  "id": 0,
  "name": "string",
  "domainName": "string",
  "directoryType": "ACTIVE_DIRECTORY",
  "credentials": "string",
  "company": {
    "id": 0,
    "name": "string"
  },
  "users": 0,
  "userGroups": 0,
  "baseDNForCardUsers": "string",
  "useSecureLDAP": true,
  "enableSSO": true,
  "accessViaClient": true,
  "proxies": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "LDAPQueryParameters": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "defaultValue": "string",
      "isOverridden": true
    }
  ],
  "attributeMap": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "defaultValue": "string",
      "isOverridden": true
    }
  ],
  "globalConfigInfo": {
    "id": "string",
    "name": "string",
    "commcells": [
      {
        "id": 0,
        "name": "string",
        "guid": "string"
      }
    ],
    "scope": "string",
    "scopeFilterQuery": "string",
    "applyOnAllCommCells": true,
    "isMarkedForDeletion": true,
    "status": "string"
  }
}

{
  "id": 85,
  "name": "domain.com",
  "domainName": "domain",
  "directoryType": "ACTIVE_DIRECTORY",
  "credentials": "username",
  "company": {
    "id": 0,
    "name": "Commcell"
  },
  "users": 0,
  "userGroups": 1,
  "baseDNForCardUsers": "CN=Name,OU=Sales,OU=Employees,DC=dn,DC=domain,DC=com",
  "useSecureLDAP": false,
  "enableSSO": true,
  "accessViaClient": false
}

{
  "id": 85,
  "name": "domain.com",
  "domainName": "domain",
  "directoryType": "APPLE_DIRECTORY_SERVICE",
  "credentials": "username",
  "company": {
    "id": 0,
    "name": "Commcell"
  },
  "users": 10,
  "userGroups": 2,
  "accessViaClient": false
}

{
  "id": 74,
  "name": "domain.com",
  "domainName": "domain",
  "directoryType": "LDAP_SERVER",
  "credentials": "uid=admin,cn=users,cn=compat,dc=domain,dc=com",
  "company": {
    "id": 0,
    "name": "Commcell"
  },
  "users": 10,
  "userGroups": 5,
  "accessViaClient": true,
  "proxies": [
    {
      "id": 2,
      "name": "client2"
    }
  ],
  "LDAPQueryParameters": [
    {
      "id": 6,
      "name": "User group filter",
      "value": "(objectClass=groupofnames)",
      "defaultValue": "(objectClass=group)",
      "isOverridden": true
    },
    {
      "id": 7,
      "name": "User filter",
      "value": "(objectClass=posixaccount)",
      "defaultValue": "(&(objectCategory=User)(sAMAccountName=*))",
      "isOverridden": true
    },
    {
      "id": 9,
      "name": "Unique identifier",
      "value": "uid",
      "defaultValue": "sAMAccountName",
      "isOverridden": true
    },
    {
      "id": 10,
      "name": "base DN",
      "value": "cn=accounts,dc=domain,dc=com",
      "defaultValue": "baseDN",
      "isOverridden": true
    }
  ],
  "attributeMap": [
    {
      "id": 1,
      "name": "Object class",
      "value": "objectClass",
      "defaultValue": "objectClass",
      "isOverridden": false
    },
    {
      "id": 2,
      "name": "Common name",
      "value": "common name",
      "defaultValue": "cn",
      "isOverridden": true
    },
    {
      "id": 3,
      "name": "Email",
      "value": "mail",
      "defaultValue": "mail",
      "isOverridden": false
    },
    {
      "id": 4,
      "name": "GUID",
      "value": "objectGUID",
      "defaultValue": "objectGUID",
      "isOverridden": false
    },
    {
      "id": 5,
      "name": "Dns",
      "value": "dnsroot",
      "defaultValue": "dnsroot",
      "isOverridden": false
    },
    {
      "id": 11,
      "name": "Member user group",
      "value": "member",
      "defaultValue": "member",
      "isOverridden": false
    },
    {
      "id": 12,
      "name": "Member unique identifier",
      "value": "memberuid",
      "defaultValue": "memberuid",
      "isOverridden": false
    }
  ]
}

{
  "id": 58,
  "name": "domain.com",
  "domainName": "domain",
  "directoryType": "OPEN_LDAP",
  "credentials": "cn=user,dc=domain,dc=com",
  "company": {
    "id": 1,
    "name": "Company1"
  },
  "users": 0,
  "userGroups": 0,
  "accessViaClient": true,
  "proxies": [
    {
      "id": 115,
      "name": "client115"
    },
    {
      "id": 2,
      "name": "client2"
    }
  ]
}

{
  "id": 56,
  "name": "ODS.domain.com",
  "domainName": "domain",
  "directoryType": "ORACLE_DIRECTORY",
  "credentials": "cn=ODSUser1,dc=domain,dc=com",
  "company": {
    "id": 2,
    "name": "Company2"
  },
  "users": 0,
  "userGroups": 0,
  "accessViaClient": false
}

Loading...