Versions Compared

Old Version 3

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 4

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/domaincontroller/{identifier}

domaincontroller - REST API Methods
Page Tree
rootResource - domaincontroller

Modifies an Acive Directory Domain Controller Table given a specific Table ID.

URL:

https://134.56.227.163/rest/domaincontroller/{identifier}

HTTP Method

POST

Requires Authentication:

true



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
DescriptionYesNostringnone64 - Max LengthThe description of the Domain Controller that will be referenced by the Active Directory Configuration resource.
LDAPQueryYesNostringnone256 - Max LengthApplies a filter to the Search Scope (defined in the Active Directory Configuration resource) to limit the number of active directory users included in the cache.
SearchScopeYesNostringnone256 - Max LengthSpecifies the tree location in Active Directory to use at the starting point for search queries or authentication requests.
DomainControllerYesNostringnone256 - Max LengthSpecifies an IP address or Fully Qualified Domain Name (FQDN) of the Domain Controller.
UserNameYesNostringnone256 - Max LengthSpecifies username (BindDN) to use for querying the Active Directory.
EncryptedPasswordYesNostringnone256 - Max LengthSpecifies password (BindPW) to use for querying the Active Directory.
DCPriorityYesYesint0Possible values:
  • 0 - Minimum
  • 5 - Maximum
Sets the priority of the DC which determines in what order AD will be queried.
Note

This has no affect when using the AD cache.

Note

Each DC type (Auth and call routing) have their own set of priorities.

Note

Priority of 0 indicates not configured. Set a valid priority.

DCTypeYesNoint0Possible values:
  • 0 - Minimum
  • 1 - Maximum
Determines whether this DC will be used for user authentication or call routing.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
Put code example here

Response:

Code Block
languagehtml/xml
Put Code response here