Documentation
Table of Contents
- userdirectory.test
- §°§á§Ú§ã
- §±§Ñ§â§Ñ§Þ§Ö§ä§â§Ú
- §±§à§Ó§â§Ñ§ä§ß§Ö §Ó§â§Ö§Õ§ß§à§ã§ä§Ú
- §±§â§Ú§Þ§Ö§â§Ú
- §´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ù§Ñ §á§à§ã§ä§à?§Ö?§Ö§Ô §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
- §´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ù§Ñ §ß§Ö§á§à§ã§ä§à?§Ö?§Ö§Ô §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
- §´§Ö§ã§ä§Ú§â§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Ô §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§Ñ §Ù§Ñ §á§â§à§Ó§Ú§Ù§Ú§à§ß§Ú§ã§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
- §ª§Ù§Ó§à§â
userdirectory.test
§°§á§Ú§ã
object userdirectory.test(array userDirectory)
§°§Ó§Ñ? §Þ§Ö§ä§à§Õ §à§Þ§à§Ô§å?§Ñ§Ó§Ñ §ä§Ö§ã§ä§Ú§â§Ñ?§Ö §á§à§ã§ä§Ñ§Ó§Ü§Ú §Ó§Ö§Ù§Ö §ã§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú§Þ §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§à§Þ.
§°§Ó§Ñ? §Þ§Ö§ä§à§Õ §ä§Ñ§Ü§à?§Ö §à§Þ§à§Ô§å?§Ñ§Ó§Ñ §Õ§Ñ §ã§Ö §ä§Ö§ã§ä§Ú§â§Ñ §Ü§à?§Ú §Ü§à§ß§æ§Ú§Ô§å§â§Ú§ã§Ñ§ß§Ú §á§à§Õ§Ñ§è§Ú §à§Õ§Ô§à§Ó§Ñ§â§Ñ?§å §á§à§Õ§Ö§ê§Ñ§Ó§Ñ?§Ú§Þ§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Ô §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§Ñ §Ù§Ñ §à§Ò§Ö§Ù§Ò§Ö?§Ú§Ó§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ (§ß§á§â. §Ü§à?§Ñ ?§Ö §å§Ý§à§Ô§Ñ §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ, §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ö §Ô§â§å§á§Ö, §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Þ§Ö§Õ§Ú?§Ú §Ò§Ú§ä§Ú §Õ§à§Õ§Ö?§Ö§ß§Ú §Ü§à§â§Ú§ã§ß§Ú§Ü§å). §©§Ñ §à§Ó§å §Ó§â§ã§ä§å §ä§Ö§ã§ä§Ñ, API §Ù§Ñ§ç§ä§Ö§Ó §ä§â§Ö§Ò§Ñ §Õ§Ñ §ã§Ö §å§á§å§ä§Ú §Ù§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ü§à?§Ú §Ú§Þ§Ñ provision_status §á§à§Õ§Ö§ê§Ö§ß §ß§Ñ §à§Þ§à§Ô§å?§Ö§ß.
§°§Ó§Ñ? §Þ§Ö§ä§à§Õ ?§Ö §Õ§à§ã§ä§å§á§Ñ§ß §ã§Ñ§Þ§à §ä§Ú§á§å §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ §³§å§á§Ö§â §Ñ§Õ§Þ§Ú§ß§Ú§ã§ä§â§Ñ§ä§à§â.
§±§Ñ§â§Ñ§Þ§Ö§ä§â§Ú
(object) §³§Ó§à?§ã§ä§Ó§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Ô §Ú§Þ§Ö§ß§Ú§Ü§Ñ.
§±§à§ê§ä§à API userdirectory.get §ß§Ö §Ó§â§Ñ?§Ñ §á§à?§Ö bind_password, §ä§â§Ö§Ò§Ñ §ß§Ñ§Ó§Ö§ã§ä§Ú userdirectoryid §Ú/§Ú§Ý§Ú bind_password.
§±§à§â§Ö§Õ §ã§ä§Ñ§ß§Õ§Ñ§â§Õ§ß§Ú§ç §ã§Ó§à?§ã§ä§Ñ§Ó§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Ô §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§Ñ, §Þ§Ö§ä§à§Õ §á§â§Ú§ç§Ó§Ñ§ä§Ñ §ã§Ý§Ö§Õ§Ö?§Ö §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ö.
| Parameter | Type | Description |
|---|---|---|
| test_username | string | §¬§à§â§Ú§ã§ß§Ú§é§Ü§à §Ú§Þ§Ö §Ù§Ñ §ä§Ö§ã§ä§Ú§â§Ñ?§Ö §å §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Þ §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§å. |
| test_password | string | §§à§Ù§Ú§ß§Ü§Ñ §á§à§Ó§Ö§Ù§Ñ§ß§Ñ §ã§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú§Þ §Ú§Þ§Ö§ß§à§Þ §Ù§Ñ §ä§Ö§ã§ä§Ú§â§Ñ?§Ö §å §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Þ §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§å. |
§±§à§Ó§â§Ñ§ä§ß§Ö §Ó§â§Ö§Õ§ß§à§ã§ä§Ú
(bool) §£§â§Ñ?§Ñ true §å §ã§Ý§å§é§Ñ?§å §å§ã§á§Ö§ç§Ñ.
§±§â§Ú§Þ§Ö§â§Ú
§´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ù§Ñ §á§à§ã§ä§à?§Ö?§Ö§Ô §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
§´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ "3" §Ù§Ñ "§Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ1".
{
"jsonrpc": "2.0",
"method": "userdirectory.test",
"params": {
"userdirectoryid": "3",
"host": "127.0.0.1",
"port": "389",
"base_dn": "ou=Users,dc=example,dc=org",
"search_attribute": "uid",
"bind_dn": "cn=ldap_search,dc=example,dc=org",
"bind_password": "password",
"test_username": "user1",
"test_password": "password"
},
"id": 1
}§°§Õ§Ô§à§Ó§à§â:
§´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ù§Ñ §ß§Ö§á§à§ã§ä§à?§Ö?§Ö§Ô §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
§´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ú §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ "3" §Ù§Ñ §ß§Ö§á§à§ã§ä§à?§Ö?§Ö§Ô "§Ü§à§â§Ú§ã§ß§Ú§Ü2".
{
"jsonrpc": "2.0",
"method": "userdirectory.test",
"params": {
"userdirectoryid": "3",
"host": "127.0.0.1",
"port": "389",
"base_dn": "ou=Users,dc=example,dc=org",
"search_attribute": "uid",
"bind_dn": "cn=ldap_search,dc=example,dc=org",
"test_username": "user2",
"test_password": "password"
},
"id": 1
}§°§Õ§Ô§à§Ó§à§â:
{
"jsonrpc": "2.0",
"error": {
"code": -32500,
"message": "Application error.",
"data": "Incorrect user name or password or account is temporarily blocked."
},
"id": 1
}§´§Ö§ã§ä§Ú§â§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§é§Ü§à§Ô §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§Ñ §Ù§Ñ §á§â§à§Ó§Ú§Ù§Ú§à§ß§Ú§ã§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ
§´§Ö§ã§ä§Ú§â§Ñ?§ä§Ö §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ "3" §Õ§Ñ §Ò§Ú§ã§ä§Ö §å§ä§Ó§â§Õ§Ú§Ý§Ú §Ü§à?§Ú §Ü§à§ß§æ§Ú§Ô§å§â§Ú§ã§Ñ§ß§Ú §á§à§Õ§Ñ§è§Ú §à§Õ§Ô§à§Ó§Ñ§â§Ñ?§å §á§à§Õ§Ö§ê§Ñ§Ó§Ñ?§Ú§Þ§Ñ §Õ§Ú§â§Ö§Ü§ä§à§â§Ú?§å§Þ§Ñ §Ù§Ñ §á§â§à§Ó§Ú§Ù§Ú§à§ß§Ú§ã§Ñ?§Ö §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ "§Ü§à§â§Ú§ã§ß§Ú§Ü3" (§ß§á§â. §Ü§à?§Ñ §Ü§à§â§Ú§ã§ß§Ú§é§Ü§Ñ §å§Ý§à§Ô§Ñ, §Ô§â§å§á§Ö §Ü§à§â§Ú§ã§ß§Ú§Ü§Ñ §Ú §Þ§Ö§Õ§Ú?§Ú ?§Ö §Ò§Ú§ä§Ú §Õ§à§Õ§Ö?§Ö§ß§Ú §Ü§à§â§Ú§ã§ß§Ú§Ü§å).
{
"jsonrpc": "2.0",
"method": "userdirectory.test",
"params": {
"userdirectoryid": "2",
"host": "host.example.com",
"port": "389",
"base_dn": "DC=zbx,DC=local",
"search_attribute": "sAMAccountName",
"bind_dn": "CN=Admin,OU=Users,OU=Áú»¢¶Ä²©,DC=zbx,DC=local",
"test_username": "user3",
"test_password": "password"
},
"id": 1
}§°§Õ§Ô§à§Ó§à§â:
{
"jsonrpc": "2.0",
"result": {
"username": "user3",
"name": "John",
"surname": "Doe",
"medias": [],
"usrgrps": [
{
"usrgrpid": "8"
},
{
"usrgrpid": "7"
}
],
"roleid": "2",
"userdirectoryid": "2"
},
"id": 1
}§ª§Ù§Ó§à§â
CUserDirectory::test() §å ui/include/classes/api/services/CUserDirectory.php.