Documentation
Table of Contents
userdirectory.get
Beschrijving
integer/array userdirectory.get(object parameters)
Deze methode maakt het mogelijk om gebruikersmappen op te halen aan de hand van de opgegeven parameters.
Deze methode is alleen beschikbaar voor gebruikers van het type Super admin.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Omschrijving |
|---|---|---|
| userdirectoryids | string/array | Geef alleen gebruikersdirectories terug met de opgegeven ID's. |
| selectUsrgrps | query | Geef een eigenschap usrgrps terug met gebruikersgroepen die zijn gekoppeld aan een gebruikersdirectory.Ondersteunt count. |
| selectProvisionMedia | query | Geef een eigenschap provision_media terug met mediatype-koppelingen die zijn gekoppeld aan een gebruikersdirectory. |
| selectProvisionGroups | query | Geef een eigenschap provision_groups terug met provisioning-groepskoppelingen die zijn gekoppeld aan een gebruikersdirectory. |
| sortfield | string/array | Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden: name. |
| filter | object | Geef alleen resultaten terug die precies overeenkomen met de opgegeven filter. Accepteert een object, waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde of een reeks waarden zijn. Ondersteunde sleutels: userdirectoryid, idp_type, provision_status. |
| search | object | Geef resultaten terug die overeenkomen met het opgegeven patroon (hoofdletterongevoelig). Mogelijke waarden: name, description.Een gebruikersdirectory van het type SAML heeft een lege waarde voor zowel de velden name als description. Beide velden kunnen worden gewijzigd met de operatie userdirectory.update. |
| countOutput | boolean | Deze parameters, die veel voorkomen bij alle get-methoden, worden in detail beschreven in het referentiecommentaar. |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Retourwaarden
(integer/array) Geeft ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputis gebruikt.
Voorbeelden
Gebruikersdirectories ophalen
Haal alle gebruikersdirectories op met aanvullende eigenschappen die mediatype-koppelingen en provisioning-groepskoppelingen weergeven die zijn gekoppeld aan elke gebruikersdirectory.
{
"jsonrpc": "2.0",
"method": "userdirectory.get",
"params": {
"output": "extend",
"selectProvisionMedia": "extend",
"selectProvisionGroups": "extend"
},
"id": 1
}Reactie:
{
"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": [
{
"name": "example.com",
"mediatypeid": "1",
"attribute": "[email protected]"
}
],
"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=Beheerder,OU=Gebruikers,OU=Zabbix,DC=zbx,DC=local",
"start_tls": "0",
"search_filter": "",
"group_basedn": "OU=Zabbix,DC=zbx,DC=local",
"group_name": "CN",
"group_member": "lid",
"group_filter": "(%{groupattr}=CN=%{ref},OU=Gebruikers,OU=Zabbix,DC=zbx,DC=local)",
"group_membership": "",
"user_username": "voornaam",
"user_lastname": "achternaam",
"user_ref_attr": "CN",
"provision_media": [
{
"name": "voorbeeld.com",
"mediatypeid": "1",
"attribute": "[email protected]"
}
],
"provision_groups": [
{
"name": "*",
"roleid": "4",
"user_groups": [
{
"usrgrpid": "8"
}
]
},
{
"name": "Zabbix-beheerders",
"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=Gebruikers,dc=voorbeeld,dc=org",
"search_attribute": "uid",
"bind_dn": "cn=ldap_search,dc=voorbeeld,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
}##### Gebruikersdirectories ophalen
Haal alle gebruikersdirectories op met aanvullende eigenschappen die mediatype-koppelingen en provisioning-groepskoppelingen weergeven die zijn gekoppeld aan elke gebruikersdirectory.
[Aanvraag](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "userdirectory.get",
"params": {
"output": "extend",
"selectProvisionMedia": "extend",
"selectProvisionGroups": "extend"
},
"id": 1
}Reactie:
{
"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": [
{
"name": "example.com",
"mediatypeid": "1",
"attribute": "[email protected]"
}
],
"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=Beheerder,OU=Gebruikers,OU=Zabbix,DC=zbx,DC=local",
"start_tls": "0",
"search_filter": "",
"group_basedn": "OU=Zabbix,DC=zbx,DC=local",
"group_name": "CN",
"group_member": "lid",
"group_filter": "(%{groupattr}=CN=%{ref},OU=Gebruikers,OU=Zabbix,DC=zbx,DC=local)",
"group_membership": "",
"user_username": "voornaam",
"user_lastname": "achternaam",
"user_ref_attr": "CN",
"provision_media": [
{
"name": "voorbeeld.com",
"mediatypeid": "1",
"attribute": "[email protected]"
}
],
"provision_groups": [
{
"name": "*",
"roleid": "4",
"user_groups": [
{
"usrgrpid": "8"
}
]
},
{
"name": "Zabbix-beheerders",
"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=Gebruikers,dc=voorbeeld,dc=org",
"search_attribute": "uid",
"bind_dn": "cn=ldap_search,dc=voorbeeld,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
}```
Zie ook
Bron
CUserDirectory::get() in ui/include/classes/api/services/CUserDirectory.php.