Add LDAP Server

POST/zstack/v1/ldap/servers

Request

cURL

curl --request POST \
  --url '/v1/ldap/servers' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/ldap/servers"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "miao",
    "description": "miao desc",
    "url": "ldap://localhost:1888",
    "base": "dc=example,dc=com",
    "username": "",
    "password": "",
    "encryption": "None",
    "serverType": "WindowsAD",
    "usernameProperty": "cn",
    "filter": "(cn=Micha Kops)",
    "syncCreatedAccountStrategy": "CreateAccount",
    "syncDeletedAccountStrategy": "StaleAccount"
  },
  "systemTags": [],
  "userTags": []
}

In the preceding example, the systemTags and userTags fields are optional. They are listed here to show that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"miao","description":"miao desc","url":"ldap://localhost:1888","base":"dc=example,dc=com","username":"","password":"","encryption":"None","serverType":"WindowsAD","usernameProperty":"cn","filter":"(cn=Micha Kops)","syncCreatedAccountStrategy":"CreateAccount","syncDeletedAccountStrategy":"StaleAccount"}}' \
http://localhost:8080/zstack/v1/ldap/servers

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
name	String	body (enclosed in the `params` structure)	Resource name		4.3.0
description (Optional)	String	body (enclosed in the `params` structure)	Detailed description of the resource		4.3.0
url	String	body (enclosed in the `params` structure)	LDAP server access URL		4.3.0
base	String	body (enclosed in the `params` structure)	LDAP server query BaseDN		4.3.0
username	String	body (enclosed in the `params` structure)	Username for accessing the LDAP server		4.3.0
password	String	body (enclosed in the `params` structure)	Password		4.3.0
encryption	String	body (enclosed in the `params` structure)	Encryption method	None TLS	4.3.0
systemTags (Optional)	List	body	System tags		4.3.0
userTags (Optional)	List	body	User tags		4.3.0
serverType (Optional)	String	body (enclosed in the `params` structure)	LDAP server type	OpenLdap WindowsAD Unknown	4.3.0
usernameProperty (Optional)	String	body (enclosed in the `params` structure)	The field used as the username when a user logs in to the virtualization platform		4.3.0
filter (Optional)	String	body (enclosed in the `params` structure)	The filter used when syncing from the LDAP server, which determines which users need to be synced		4.3.0
syncCreatedAccountStrategy (Optional)	String	body (enclosed in the `params` structure)	The strategy for handling newly created users on the LDAP server during synchronization: create a corresponding account or take no action	NoAction CreateDisabledAccount CreateAccount	4.3.0
syncDeletedAccountStrategy (Optional)	String	body (enclosed in the `params` structure)	The strategy for handling deleted users on the LDAP server during synchronization: delete the corresponding account, mark as stale, or take no action	NoAction StaleAccount DeleteAccount	4.3.0

API Response

Response Example

{
  "inventory": {
    "uuid": "01b489793e3d31728ccbbc4fdfd99ed0",
    "name": "miao",
    "description": "miao desc",
    "url": "ldap://localhost:1888",
    "base": "dc=example,dc=com",
    "username": "",
    "password": "",
    "encryption": "None"
  }
}

Name	Type	Description	Starting Version
success	boolean		4.3.0
error	ErrorCode	Error code. If not null, the operation has failed. This field is null when the operation succeeds. For details, see error	4.3.0
inventory	LdapServerInventory	For details, see inventory	4.3.0

error

Name	Type	Description	Starting Version
code	String	Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001.	0.6
description	String	Brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. Default is null.	0.6
opaque	LinkedHashMap	Reserved field. Default is null.	0.6
cause	ErrorCode	Root error. The source error that caused the current error. This field is null if no root error exists.	0.6

inventory

Name	Type	Description	Starting Version
uuid	String	Resource UUID. Uniquely identifies the resource.	4.3.0
name	String	Resource name	4.3.0
type	String	User source type, typically ldap	4.3.0
description	String	Detailed description of the resource	4.3.0
url	String		4.3.0
base	String	LDAP server access URL	4.3.0
username	String	Username for accessing the LDAP server	4.3.0
password	String	Password	4.3.0
encryption	String	Encryption method	4.3.0
serverType	String	Server type. Possible values are OpenLdap or WindowsAD. Returns Unknown if the type cannot be determined.	4.3.0
createDate	Timestamp	Creation time	4.3.0
lastOpDate	Timestamp	Last modification time	4.3.0

SDK Examples

Java SDK

AddLdapServerAction action = new AddLdapServerAction();
action.name = "miao";
action.description = "miao desc";
action.url = "ldap://localhost:1888";
action.base = "dc=example,dc=com";
action.username = "";
action.password = "";
action.encryption = "None";
action.serverType = "WindowsAD";
action.usernameProperty = "cn";
action.filter = "(cn=Micha Kops)";
action.syncCreatedAccountStrategy = "CreateAccount";
action.syncDeletedAccountStrategy = "StaleAccount";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddLdapServerAction.Result res = action.call();

Python SDK

AddLdapServerAction action = AddLdapServerAction()
action.name = "miao"
action.description = "miao desc"
action.url = "ldap://localhost:1888"
action.base = "dc=example,dc=com"
action.username = ""
action.password = ""
action.encryption = "None"
action.serverType = "WindowsAD"
action.usernameProperty = "cn"
action.filter = "(cn=Micha Kops)"
action.syncCreatedAccountStrategy = "CreateAccount"
action.syncDeletedAccountStrategy = "StaleAccount"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddLdapServerAction.Result res = action.call()