userdirectory.create

Описание

object userdirectory.create(object/array userDirectory)

Этот метод позволяет создавать новые каталоги пользователей.

Параметры

(object/array) Каталоги пользователей для создания.

Метод принимает каталоги пользователей со стандартными свойствами каталога пользователей.

Возвращаемые значения

(object) Возвращает объект, содержащий идентификаторы созданных каталогов пользователей в свойстве userdirectoryids. Порядок возвращаемых идентификаторов соответствует порядку переданных каталогов пользователей.

Примеры

Создание каталога пользователей

Создайте каталог пользователей для аутентификации пользователей с использованием StartTLS через LDAP. Обратите внимание, что для аутентификации пользователей через LDAP должна быть включена LDAP-аутентификация.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.create",
    "params": {
        "idp_type": "1",
        "name": "LDAP API server #1",
        "host": "ldap://local.ldap",
        "port": "389",
        "base_dn": "ou=Users,dc=example,dc=org",
        "bind_dn": "cn=ldap_search,dc=example,dc=org",
        "bind_password": "ldapsecretpassword",
        "search_attribute": "uid",
        "start_tls": "1"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userdirectoryids": [
            "3"
        ]
    },
    "id": 1
}

Создание каталога пользователей (с включенным JIT provisioning)

Создайте каталог пользователей для аутентификации пользователей через LDAP (с включенным JIT provisioning). Обратите внимание, что для аутентификации пользователей через LDAP должна быть включена LDAP-аутентификация.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "userdirectory.create",
    "params": {
            "idp_type": "1",
            "name": "AD server",
            "provision_status": "1",
            "description": "",
            "host": "host.example.com",
            "port": "389",
            "base_dn": "DC=zbx,DC=local",
            "search_attribute": "sAMAccountName",
            "bind_dn": "CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
            "start_tls": "0",
            "search_filter": "",
            "group_basedn": "OU=Zabbix,DC=zbx,DC=local",
            "group_name": "CN",
            "group_member": "member",
            "group_filter": "(%{groupattr}=CN=%{ref},OU=Users,OU=Zabbix,DC=zbx,DC=local)",
            "group_membership": "",
            "user_username": "givenName",
            "user_lastname": "sn",
            "user_ref_attr": "CN",
            "provision_media": [
                {
                    "name": "example.com",
                    "mediatypeid": "1",
                    "attribute": "[email protected]"
                }
            ],
            "provision_groups": [
                {
                    "name": "*",
                    "roleid": "4",
                    "user_groups": [
                        {
                            "usrgrpid": "8"
                        }
                    ]
                },
                {
                    "name": "Zabbix administrators",
                    "roleid": "2",
                    "user_groups": [
                        {
                            "usrgrpid": "7"
                        },
                        {
                            "usrgrpid": "8"
                        }
                    ]
                }
            ]
        },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userdirectoryids": [
            "2"
        ]
    },
    "id": 1
}

Исходный код

CUserDirectory::create() в ui/include/classes/api/services/CUserDirectory.php.