userdirectory.create

Description

object userdirectory.create(object/array userDirectory)

This method allows to create new user directories.

This method is only available to Super admin user type.

Parameters

(object/array) User directories to create.

The method accepts user directories with the standard user directory properties.

Return values

(object) Returns an object containing the IDs of the created user directories under the userdirectoryids property. The order of the returned IDs matches the order of the passed user directories.

示例

Creating a user directory

Create a user directory to authenticate users with StartTLS over LDAP.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "userdirectory.create",
  4.            "params": {
  5.                "name": "LDAP API server #1",
  6.                "host": "ldap://local.ldap",
  7.                "port": "389",
  8.                "base_dn": "ou=Users,dc=example,dc=org",
  9.                "bind_dn": "cn=ldap_search,dc=example,dc=org",
  10.                "bind_password": "ldapsecretpassword",
  11.                "search_attribute": "uid",
  12.                "start_tls": "1"
  13.            },
  14.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  15.            "id": 1
  16.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "userdirectoryids": [
  5.                    "2"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }
Creating a user directory (JIT provisioning enabled)

Create a user directory to authenticate users over LDAP (with JIT provisioning enabled). Note that to authenticate users over LDAP, LDAP authentication must be enabled.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "userdirectory.create",
  4.            "params": {
  5.                    "idp_type": "1",
  6.                    "name": "AD server",
  7.                    "provision_status": "1",
  8.                    "description": "",
  9.                    "host": "host.example.com",
  10.                    "port": "389",
  11.                    "base_dn": "DC=zbx,DC=local",
  12.                    "search_attribute": "sAMAccountName",
  13.                    "bind_dn": "CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
  14.                    "start_tls": "0",
  15.                    "search_filter": "",
  16.                    "group_basedn": "OU=Zabbix,DC=zbx,DC=local",
  17.                    "group_name": "CN",
  18.                    "group_member": "member",
  19.                    "group_filter": "(%{groupattr}=CN=%{ref},OU=Users,OU=Zabbix,DC=zbx,DC=local)",
  20.                    "group_membership": "",
  21.                    "user_username": "givenName",
  22.                    "user_lastname": "sn",
  23.                    "user_ref_attr": "CN",
  24.                    "provision_media": [
  25.                        {
  26.                            "name": "example.com",
  27.                            "mediatypeid": "1",
  28.                            "attribute": "[email protected]"
  29.                        }
  30.                    ],
  31.                    "provision_groups": [
  32.                        {
  33.                            "name": "*",
  34.                            "roleid": "4",
  35.                            "user_groups": [
  36.                                {
  37.                                    "usrgrpid": "8"
  38.                                }
  39.                            ]
  40.                        },
  41.                        {
  42.                            "name": "Zabbix administrators",
  43.                            "roleid": "2",
  44.                            "user_groups": [
  45.                                {
  46.                                    "usrgrpid": "7"
  47.                                },
  48.                                {
  49.                                    "usrgrpid": "8"
  50.                                }
  51.                            ]
  52.                        }
  53.                    ]
  54.                },
  55.            "id": 1
  56.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "userdirectoryids": [
  5.                    "2"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

Source

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