Documentation
Table of Contents
userdirectory.get
説明
integer/array userdirectory.get(object parameters)
このメソッドは、指定したパラメーターに応じたユーザーディレクトリを取得できます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。
パラメータ
(object) 出力を定義するパラメータ
このメソッドは以下のパラメータをサポートしています。
| パラメータ | タイプ | 説明 |
|---|---|---|
| userdirectoryids | ID/配列 | 指定されたIDを持つユーザーディレクトリのみを返します。 |
| selectUsrgrps | クエリ | ユーザーディレクトリに関連付けられたユーザーグループを持つusrgrpsプロパティを返します。countをサポートします。 |
| selectProvisionMedia | クエリ | ユーザーディレクトリに関連付けられたメディアタイプマッピングを持つprovision_mediaプロパティを返します。 |
| selectProvisionGroups | クエリ | ユーザー ディレクトリに関連付けられた プロビジョニング グループ マッピング を持つ provision_groups プロパティを返します。 |
| sortfield | 文字列/配列 | 指定されたプロパティで結果を並べ替えます。 使用可能な値: name |
| filter | オブジェクト | 指定されたフィルターに完全に一致する結果のみを返します。 キーがプロパティ名、値が単一の値または値の配列であるオブジェクトを受け入れます。 サポートされるプロパティ: userdirectoryid、idp_type、provision_status |
| search | オブジェクト | 指定されたパターンに一致する結果を返します（大文字と小文字は区別されません）。 キーがプロパティ名、値が検索する文字列であるオブジェクトを受け入れます。追加オプションが指定されていない場合は、 LIKE "%…%" 検索が実行されます。サポートされているプロパティ: name、description。SAML タイプのユーザーディレクトリでは、 name プロパティと description プロパティの両方が空の値になります。どちらのプロパティも userdirectory.update 操作で変更できます。 |
| countOutput | boolean | これらのパラメータについては、リファレンス解説 で説明されています。 |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメーターが使用されている場合、取得したオブジェクトの数
例
ユーザーディレクトリの取得
各ユーザーディレクトリに関連付けられたメディアタイプマッピングとプロビジョニンググループマッピングを表示する追加プロパティを含むすべてのユーザーディレクトリを取得します。
リクエスト :
{
"jsonrpc": "2.0",
"method": "userdirectory.get",
"params": {
"output": "extend",
"selectProvisionMedia": "extend",
"selectProvisionGroups": "extend"
},
"id": 1
}レスポンス :
{
"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": "[email protected]",
"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": "[email protected]",
"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
}参照
ソース
CUserDirectory::get() in ui/include/classes/api/services/CUserDirectory.php.