This is a translation of the original English documentation page. Help us make it better.

userdirectory.create

説明

object userdirectory.create(object/array userDirectory)

このメソッドは、新しいユーザーディレクトリを作成します。

このメソッドは、Super adminのユーザーのみ利用可能です。

パラメータ

(object/array) 作成するユーザーディレクトリ。

このメソッドは、標準ユーザーディレクトリプロパティを持つユーザーディレクトリを受け入れます。

戻り値

(object) は、userdirectoryids プロパティに作成されたユーザーディレクトリの ID を含むオブジェクトを返します。 返される ID の順序は、渡されたユーザーディレクトリの順序と一致します。

ユーザーディレクトリの作成

StartTLS over 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
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "userdirectoryids": [
                   "3"
               ]
           },
           "id": 1
       }
ユーザーディレクトリの作成(JIT プロビジョニング有効)

LDAP 経由でユーザーを認証するためのユーザーディレクトリを作成します。(JIT プロビジョニング有効) 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
       }

Response:

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

ソース

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