Directory Service

Resources related to directory service.

ActiveDirectory

The ActiveDirectory resource represents the configuration settings for the Active Directory service integration.

List resource

GET /api/v1.0/directoryservice/activedirectory/

Returns the active directory settings dictionary.

Example request:

GET /api/v1.0/directoryservice/activedirectory/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "ad_enable": false,
          "ad_certfile": "",
          "ad_ssl": "off",
          "ad_gcname": "",
          "ad_keytab": "",
          "ad_use_keytab": false,
          "ad_use_default_domain": true,
          "ad_dcname": "",
          "ad_adminname": "",
          "ad_unix_extensions": false,
          "ad_timeout": 10,
          "ad_domainname": "",
          "id": 1,
          "ad_kpwdname": "",
          "ad_krbname": "",
          "ad_dns_timeout": 10,
          "ad_bindpw": "",
          "ad_verbose_logging": false,
          "ad_allow_trusted_doms": false,
          "ad_netbiosname": "NAS"
  }
Response Headers:
 
  • Content-Type – content type of the response
Status Codes:
  • 200 – no error

Update resource

PUT /api/v1.0/directoryservice/activedirectory/

Update active directory.

Example request:

PUT /api/v1.0/directoryservice/activedirectory/ HTTP/1.1
Content-Type: application/json

  {
          "ad_netbiosname": "mynas",
          "ad_domainname": "mydomain",
          "ad_bindname": "admin",
          "ad_bindpw": "mypw"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "ad_enable": false,
          "ad_certfile": "",
          "ad_ssl": "off",
          "ad_gcname": "",
          "ad_keytab": "",
          "ad_use_keytab": false,
          "ad_use_default_domain": true,
          "ad_dcname": "",
          "ad_bindname": "admin",
          "ad_bindpw": "mypw",
          "ad_unix_extensions": false,
          "ad_timeout": 10,
          "ad_domainname": "mydomain",
          "id": 1,
          "ad_kpwdname": "",
          "ad_krbname": "",
          "ad_dns_timeout": 10,
          "ad_verbose_logging": false,
          "ad_allow_trusted_doms": false,
          "ad_netbiosname": "mynas"
  }
JSON Parameters:
 
  • ad_enable (string) – enable active directory
  • ad_certfile (string) – ssl certificate
  • ad_ssl (string) – encryption mode (on/off/start_tls)
  • ad_domainname (string) – domain name
  • ad_netbiosname (string) – system hostname
  • ad_bindpw (string) – domain account password
  • ad_dcname (string) – hostname of the domain controller to use
  • ad_gcname (string) – hostname of the global catalog server to use
  • ad_keytab (string) – kerberos keytab file
  • ad_use_keytab (boolean) – use keytab
  • ad_krbname (string) – hostname of the kerberos server to use
  • ad_verbose_logging (boolean) – verbose logging
  • ad_unix_extensions (boolean) – unix extensions
  • ad_allow_trusted_doms (boolean) – allow Trusted Domains
  • ad_use_default_domain (boolean) – use the default domain for users and groups
  • ad_dns_timeout (integer) – timeout for AD DNS queries
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 200 – no error

LDAP

The LDAP resource represents the configuration settings for LDAP service.

List resource

GET /api/v1.0/directoryservice/ldap/

Returns the LDAP settings dictionary.

Example request:

GET /api/v1.0/directoryservice/ldap/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
  }
Response Headers:
 
  • Content-Type – content type of the response
Status Codes:
  • 200 – no error

Update resource

PUT /api/v1.0/directoryservice/ldap/

Update LDAP.

Example request:

PUT /api/v1.0/directoryservice/ldap/ HTTP/1.1
Content-Type: application/json

  {
          "ldap_hostname": "ldaphostname",
          "ldap_basedn": "dc=test,dc=org"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "ldap_hostname": "ldaphostname",
          "ldap_groupsuffix": "",
          "ldap_passwordsuffix": "",
          "ldap_anonbind": false,
          "ldap_ssl": "off",
          "ldap_machinesuffix": "",
          "ldap_basedn": "dc=test,dc=org",
          "ldap_usersuffix": "",
          "ldap_bindpw": "",
          "ldap_binddn": "",
          "ldap_enable": false,
          "ldap_certificate": "",
          "id": 1
  }
JSON Parameters:
 
  • ldap_hostname (string) – name or IP address of the LDAP server
  • ldap_basedn (string) – default base Distinguished Name (DN) to use for searches
  • ldap_anonbind (boolean) – allow anonymous binding
  • ldap_bindpw (string) – credentials with which to bind
  • ldap_binddn (string) – distinguished name with which to bind to the directory server
  • ldap_usersuffix (string) – suffix that is used for users
  • ldap_groupsuffix (string) – suffix that is used for groups
  • ldap_passwordsuffix (string) – suffix that is used for password
  • ldap_machinesuffix (string) – suffix that is used for machines
  • ldap_ssl (string) – off, on, start_tls
  • ldap_certificate (string) – id of your self signed certificate
  • ldap_enable (boolean) – enable ldap directory service
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 200 – no error

NIS

The NIS resource represents the configuration settings for NIS service.

List resource

GET /api/v1.0/directoryservice/nis/

Returns the NIS settings dictionary.

Example request:

GET /api/v1.0/directoryservice/nis/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "nis_servers": "",
          "nis_secure_mode": false,
          "nis_manycast": false,
          "id": 1,
          "nis_enable": false,
          "nis_domain": ""
  }
Response Headers:
 
  • Content-Type – content type of the response
Status Codes:
  • 200 – no error

Update resource

PUT /api/v1.0/directoryservice/nis/

Update NIS.

Example request:

PUT /api/v1.0/directoryservice/nis/ HTTP/1.1
Content-Type: application/json

  {
          "nis_domain": "nisdomain"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "nis_servers": "",
          "nis_secure_mode": false,
          "nis_manycast": false,
          "id": 1,
          "nis_enable": false,
          "nis_domain": "nisdomain"
  }
JSON Parameters:
 
  • nis_domain (string) – nis domain name
  • nis_servers (string) – comma delimited list of NIS servers
  • nis_secure_mode (boolean) – cause ypbind to run in secure mode
  • nis_manycast (boolean) – cause ypbind to use “many-cast” instead of broadcast
  • nis_enable (boolean) – enable nis
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 200 – no error

NT4

The NT4 resource represents the configuration settings for NT4 service.

List resource

GET /api/v1.0/directoryservice/nt4/

Returns the NT4 settings dictionary.

Example request:

GET /api/v1.0/directoryservice/nt4/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "nt4_adminname": "",
          "nt4_dcname": "",
          "nt4_workgroup": "",
          "nt4_netbiosname": "NAS",
          "nt4_adminpw": "",
          "nt4_enable": "false",
          "id": 1
  }
Response Headers:
 
  • Content-Type – content type of the response
Status Codes:
  • 200 – no error

Update resource

PUT /api/v1.0/directoryservice/nt4/

Update NT4.

Example request:

PUT /api/v1.0/directoryservice/nt4/ HTTP/1.1
Content-Type: application/json

  {
          "nt4_adminname": "admin",
          "nt4_dcname": "mydcname",
          "nt4_workgroup": "WORKGROUP",
          "nt4_netbiosname": "netbios",
          "nt4_adminpw": "mypw"
  }

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

  {
          "nt4_adminname": "admin",
          "nt4_dcname": "mydcname",
          "nt4_workgroup": "WORKGROUP",
          "nt4_netbiosname": "netbios",
          "nt4_adminpw": "mypw",
          "nt4_enable": "false",
          "id": 1
  }
JSON Parameters:
 
  • nt4_dcname (string) – hostname of the domain controller to use
  • nt4_netbiosname (string) – system hostname
  • nt4_workgroup (string) – workgroup or domain name in old format
  • nt4_adminname (string) – domain Administrator account name
  • nt4_adminpw (string) – domain Administrator account password
  • nt4_enable (string) – enable NT4
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 200 – no error