Update AD/LDAP
Update an AD/LDAP domain
Path Parameters
- domainId int32 required
ID of the AD/LDAP domain
- application/json
Request Body
Properties of the domain to be updated
- directoryType string required
Possible values: [
ACTIVE_DIRECTORY
,APPLE_DIRECTORY_SERVICE
,LDAP_SERVER
,OPEN_LDAP
,ORACLE_DIRECTORY
]Directory type of an AD/LDAP domain
- host string
The fully qualified domain name that you use to identify this network resource. Required only if directoryType is LDAP_SERVER
- OSXServerName string
The fully qualified domain name that you use to identify this network resource. Required only if directoryType is APPLE_DIRECTORY_SERVICE
- NETBIOSName string
The fully qualified domain name that you use to identify this network resource. Required only if directoryType is ACTIVE_DIRECTORY, OPEN_LDAP or ORACLE_DIRECTORY
- name string required
The fully qualified domain name, for example, my.domain.example.com
- username string
The username for a user who has at least read permission for the domain
- password string
Password for the domain user. Should be in Base64 encoded format.
- baseDNForCardUsers string
Base DN for card users
- useSecureLDAP boolean
Boolean to indicate if the app use secure LDAP. Valid only for directory types - ACTIVE_DIRECTORY, ORACLE_DIRECTORY and LDAP_SERVER.
- enableSSO boolean
Denotes if SSO should be enabled for the domain. Valid only for ACTIVE_DIRECTORY.
- accessViaClient boolean
Denotes if the domain is to be accessed via a proxy
proxies object[]
LDAPQueryParameters object[]
attributeMap object[]
- 200
- 400
OK
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Request body is empty or format is invalid.
PUT /v4/ldap/:domainid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V4/LDAP/:domainId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"directoryType": "ACTIVE_DIRECTORY",
"host": "string",
"OSXServerName": "string",
"NETBIOSName": "string",
"name": "string",
"username": "string",
"password": "string",
"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
}
]
}'