[comment]: # ({53d969c5-f9e8f670}) # userdirectory.get [comment]: # ({/53d969c5-f9e8f670}) [comment]: # ({f09e8f55-b5ff62ed}) ### 説明 `integer/array userdirectory.get(object parameters)` このメソッドは、指定したパラメーターに応じたユーザーディレクトリを取得できます。 ::: noteclassic このメソッドは、*Super admin*タイプのユーザーのみ利用可能です。 ::: [comment]: # ({/f09e8f55-b5ff62ed}) [comment]: # ({56a05aef-d99c84a0}) ### パラメータ `(object)` 必要な出力を定義するパラメータです。 このメソッドは以下のパラメータをサポートしています。 |パラメータ|[型](/manual/api/reference_commentary#data-types)|説明| |--|--|------| |userdirectoryids|ID/array|指定したIDを持つユーザーディレクトリのみを返します。| |selectUsrgrps|query|ユーザーディレクトリに関連付けられた[ユーザーグループ](/manual/api/reference/usergroup/object)を含む `usrgrps` プロパティを返します。

`count` をサポートします。| |selectProvisionMedia|query|ユーザーディレクトリに関連付けられた[メディアタイプマッピング](/manual/api/reference/userdirectory/object#media-type-mappings)を含む `provision_media` プロパティを返します。| |selectProvisionGroups|query|ユーザーディレクトリに関連付けられた[プロビジョニンググループマッピング](/manual/api/reference/userdirectory/object#provisioning-groups-mappings)を含む `provision_groups` プロパティを返します。| |sortfield|string/array|指定したプロパティで結果をソートします。

指定可能な値: `name`。| |filter|object|指定したフィルターに完全に一致する結果のみを返します。

プロパティ名をキーとし、値を単一の値または値の配列とするオブジェクトを受け付けます。

サポートされるプロパティ: `userdirectoryid`, `idp_type`, `provision_status`。| |search|object|指定したパターンに一致する結果を返します（大文字・小文字を区別しません）。

プロパティ名をキー、検索する文字列を値とするオブジェクトを受け付けます。追加オプションが指定されていない場合、`LIKE "%…%"` 検索が実行されます。

サポートされるプロパティ: `name`, `description`。

SAMLタイプのユーザーディレクトリでは、`name` と `description` の両方のプロパティは空の値になります。両方のプロパティは `userdirectory.update` 操作で変更できます。| |countOutput|boolean|これらのパラメータは[リファレンスコメント](/manual/api/reference_commentary#common-get-method-parameters)で説明されています。| |excludeSearch|boolean|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/56a05aef-d99c84a0}) [comment]: # ({07ca11ca-a18ff82b}) ### 戻り値 `(integer/array)` 次のいずれかを返します。 - オブジェクトの配列 - `countOutput`パラメータが使用されている場合は、取得したオブジェクトの数 [comment]: # ({/07ca11ca-a18ff82b}) [comment]: # ({b41637d2-ba1c8d4c}) ### 例 [comment]: # ({/b41637d2-ba1c8d4c}) [comment]: # ({dee71092-6acef378}) ##### ユーザーディレクトリの取得 各ユーザーディレクトリに関連付けられたメディアタイプマッピングとプロビジョニンググループマッピングを表示する追加プロパティを含むすべてのユーザーディレクトリを取得します。 [リクエスト](/manual/api#performing-requests) : ```json { "jsonrpc": "2.0", "method": "userdirectory.get", "params": { "output": "extend", "selectProvisionMedia": "extend", "selectProvisionGroups": "extend" }, "id": 1 } ``` レスポンス : ```json { "jsonrpc": "2.0", "result": [ { "userdirectoryid": "1", "idp_type": "2", "name": "", "provision_status": "1", "description": "", "group_name": "groups", "user_username": "", "user_lastname": "", "idp_entityid": "http://example.com/simplesaml/saml2/idp/metadata.php", "sso_url": "http://example.com/simplesaml/saml2/idp/SSOService.php", "slo_url": "", "username_attribute": "uid", "sp_entityid": "zabbix", "nameid_format": "", "sign_messages": "0", "sign_assertions": "0", "sign_authn_requests": "0", "sign_logout_requests": "0", "sign_logout_responses": "0", "encrypt_nameid": "0", "encrypt_assertions": "0", "scim_status": "1", "provision_media": [ { "userdirectory_mediaid": "1", "name": "example.com", "mediatypeid": "1", "attribute": "user@example.com", "active": "0", "severity": "63", "period": "1-7,00:00-24:00" } ], "provision_groups": [ { "name": "*", "roleid": "1", "user_groups": [ { "usrgrpid": "13" } ] } ] }, { "userdirectoryid": "2", "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": [ { "userdirectory_mediaid": "2", "name": "example.com", "mediatypeid": "1", "attribute": "user@example.com", "active": "0", "severity": "63", "period": "1-7,00:00-24:00" } ], "provision_groups": [ { "name": "*", "roleid": "4", "user_groups": [ { "usrgrpid": "8" } ] }, { "name": "Zabbix administrators", "roleid": "2", "user_groups": [ { "usrgrpid": "7" }, { "usrgrpid": "8" } ] } ] }, { "userdirectoryid": "3", "idp_type": "1", "name": "LDAP API server #1", "provision_status": "0", "description": "", "host": "ldap://local.ldap", "port": "389", "base_dn": "ou=Users,dc=example,dc=org", "search_attribute": "uid", "bind_dn": "cn=ldap_search,dc=example,dc=org", "start_tls": "1", "search_filter": "", "group_basedn": "", "group_name": "", "group_member": "", "group_filter": "", "group_membership": "", "user_username": "", "user_lastname": "", "user_ref_attr": "", "provision_media": [], "provision_groups": [] } ], "id": 1 } ``` [comment]: # ({/dee71092-6acef378}) [comment]: # ({860ec55f-5f3bc200}) ### 参照 - [User group](/manual/api/reference/usergroup/object#user) [comment]: # ({/860ec55f-5f3bc200}) [comment]: # ({901c82dd-392498dd}) ### ソース CUserDirectory::get() in *ui/include/classes/api/services/CUserDirectory.php*. [comment]: # ({/901c82dd-392498dd})