获取可绑定的AD/LDAP条目(GetCandidateLdapEntryForBinding)

获取可绑定的AD/LDAP条目（排除已绑定的AD/LDAP条目）。

API请求

URLs

GET zstack/v1/ldap/entries/candidates

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/ldap/entries/candidates?ldapFilter=(cn=user_xxx)&limit=2500.0

参数列表


名字	类型	位置	描述	起始版本
ldapFilter	String	query	查询条件	2.2
systemTags (可选)	List	query		2.2
userTags (可选)	List	query		2.2
limit (可选)	Integer	query	最多返回的记录数，类似MySQL的limit	2.2

API返回

返回示例

{
    "inventories": [
        {
            "attributes": [
                {
                    "id": "userPrincipalName",
                    "orderMatters": false,
                    "values": [
                        "weiqi@adtest.zs"
                    ],
                    "valuesAsNames": {}
                },
                {
                    "id": "displayName",
                    "orderMatters": false,
                    "values": [
                        "zstest"
                    ],
                    "valuesAsNames": {}
                },
                {
                    "id": "name",
                    "orderMatters": false,
                    "values": [
                        "weiqi"
                    ],
                    "valuesAsNames": {}
                },
                {
                    "id": "distinguishedName",
                    "orderMatters": false,
                    "values": [
                        "CN=weiqi,OU=ui,OU=zstest,DC=adtest,DC=zs"
                    ],
                    "valuesAsNames": {}
                },
                {
                    "id": "cn",
                    "orderMatters": false,
                    "values": [
                        "weiqi"
                    ],
                    "valuesAsNames": {}
                },
                {
                    "id": "objectClass",
                    "orderMatters": false,
                    "values": [
                        "top",
                        "person",
                        "organizationalPerson",
                        "user"
                    ],
                    "valuesAsNames": {}
                }
            ],
            "dn": "CN=weiqi,OU=ui,OU=zstest,dc=adtest,dc=zs"
        }
    ],
    "success": true
}


名字	类型	描述	起始版本
inventories	List		2.2
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.2

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	2.2
description	String	错误的概要描述	2.2
details	String	错误的详细信息	2.2
elaboration	String	保留字段，默认为null	2.2
opaque	LinkedHashMap	保留字段，默认为null	2.2
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	2.2

SDK示例

Java SDK

GetCandidateLdapEntryForBindingAction action = new GetCandidateLdapEntryForBindingAction();
action.ldapFilter = "(cn=user_xxx)";
action.limit = 2500.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateLdapEntryForBindingAction.Result res = action.call();

Python SDK

GetCandidateLdapEntryForBindingAction action = GetCandidateLdapEntryForBindingAction()
action.ldapFilter = "(cn=user_xxx)"
action.limit = 2500.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidateLdapEntryForBindingAction.Result res = action.call()