测试

描述

object userdirectory.test(array userDirectory)

此方法用于测试用户目录连接设置。

此方法还用于测试哪些配置的数据与用户配置的用户目录设置相匹配 (例如，什么用户角色、用户组、用户媒体将被分配给用户)。 对于该类型的测试，需由用户目录发出api请求，其provision_status需设置为enabled。

此方法仅适用于Super admin(超级管理员)类型的用户。

参数

(object) 用户目录属性。

由于userdirectory.get API不返回bind_password 字段，因此应提供 userdirectoryid 和/或 bind_password 。

除了标准用户目录属性之外，该方法还接受以下参数。

参数类型描述
test_usernamestring在用户目录中测试用户名。
test_passwordstring在用户目录中测试用户名的关联密码。

返回值

(bool) 成功时返回true。

示例

测试现有用户的用户目录

使用 “user1” 测试用户目录 “3”。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "userdirectory.test",
  4.            "params": {
  5.                "userdirectoryid": "3",
  6.                "host": "127.0.0.1",
  7.                "port": "389",
  8.                "base_dn": "ou=Users,dc=example,dc=org",
  9.                "search_attribute": "uid",
  10.                "bind_dn": "cn=ldap_search,dc=example,dc=org",
  11.                "bind_password": "password",
  12.                "test_username": "user1",
  13.                "test_password": "password"
  14.            },
  15.            "id": 1
  16.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": true,
  4.            "id": 1
  5.        }
测试非现有用户的用户目录

测试非现有用户 “user2” 的用户目录 “3”。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "userdirectory.test",
  4.            "params": {
  5.                "userdirectoryid": "3",
  6.                "host": "127.0.0.1",
  7.                "port": "389",
  8.                "base_dn": "ou=Users,dc=example,dc=org",
  9.                "search_attribute": "uid",
  10.                "bind_dn": "cn=ldap_search,dc=example,dc=org",
  11.                "test_username": "user2",
  12.                "test_password": "password"
  13.            },
  14.            "id": 1
  15.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "error": {
  4.                "code": -32500,
  5.                "message": "Application error.",
  6.                "data": "Incorrect user name or password or account is temporarily blocked."
  7.            },
  8.            "id": 1
  9.        }
测试用户配置的用户目录

测试用户目录”3”，了解配置的数据与 “user3” 设置的用户目录设置相匹配 (例如，什么用户角色、用户组、用户媒介将被分配给用户)。

请求:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "userdirectory.test",
  4.            "params": {
  5.                "userdirectoryid": "2",
  6.                "host": "host.example.com",
  7.                "port": "389",
  8.                "base_dn": "DC=zbx,DC=local",
  9.                "search_attribute": "sAMAccountName",
  10.                "bind_dn": "CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
  11.                "test_username": "user3",
  12.                "test_password": "password"
  13.            },
  14.            "id": 1
  15.        }

响应:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "username": "user3",
  5.                "name": "John",
  6.                "surname": "Doe",
  7.                "medias": [],
  8.                "usrgrps": [
  9.                    {
  10.                        "usrgrpid": "8"
  11.                    },
  12.                    {
  13.                        "usrgrpid": "7"
  14.                    }
  15.                ],
  16.                "roleid": "2",
  17.                "userdirectoryid": "2"
  18.            },
  19.            "id": 1
  20.        }

来源

CUserDirectory::test() in ui/include/classes/api/services/CUserDirectory.php.