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

userdirectory.test

Beschrijving

object userdirectory.test(array userDirectory)

Deze methode maakt het mogelijk om de verbindingsinstellingen van de gebruikersmap te testen.

Deze methode maakt ook het testen mogelijk van welke geconfigureerde gegevens overeenkomen met de gebruikersmapinstellingen voor gebruikersprovisionering (bijvoorbeeld welke gebruikersrol, gebruikersgroepen, gebruikersmedia aan de gebruiker zullen worden toegewezen). Voor dit type test moet het API-verzoek worden gedaan voor een gebruikersmap waarvan provision_status is ingesteld op ingeschakeld.

Deze methode is alleen beschikbaar voor gebruikers van het type Super admin.

Parameters

(object) Eigenschappen van de gebruikersmap.

Omdat de API userdirectory.get het veld bind_password niet teruggeeft, moeten userdirectoryid en/of bind_password worden verstrekt.
Naast de standaard eigenschappen van de gebruikersmap, accepteert de methode de volgende parameters.

Parameter Type Beschrijving
test_username string Gebruikersnaam om te testen in de gebruikersmap.
test_password string Gebruikersnaam-geassocieerd wachtwoord om te testen in de gebruikersmap.

Retourwaarden

(bool) Geeft waar terug bij succes.

Voorbeelden

Test gebruikersmap voor bestaande gebruiker

Test gebruikersmap "3" voor "gebruiker1".

Aanvraag:

{
           "jsonrpc": "2.0",
           "methode": "gebruikersmap.testen",
           "parameters": {
               "gebruikersmapid": "3",
               "host": "127.0.0.1",
               "poort": "389",
               "base_dn": "ou=Gebruikers,dc=voorbeeld,dc=org",
               "zoek_attribuut": "uid",
               "bind_dn": "cn=ldap_zoekopdracht,dc=voorbeeld,dc=org",
               "bind_wachtwoord": "wachtwoord",
               "test_gebruikersnaam": "gebruiker1",
               "test_wachtwoord": "wachtwoord"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "resultaat": true,
           "id": 1
       }
Test gebruikersmap voor niet-bestaande gebruiker

Test gebruikersmap "3" voor niet-bestaande "gebruiker2".

Aanvraag:

{
           "jsonrpc": "2.0",
           "methode": "gebruikersmap.testen",
           "parameters": {
               "gebruikersmapid": "3",
               "host": "127.0.0.1",
               "poort": "389",
               "base_dn": "ou=Gebruikers,dc=voorbeeld,dc=org",
               "zoek_attribuut": "uid",
               "bind_dn": "cn=ldap_zoekopdracht,dc=voorbeeld,dc=org",
               "test_gebruikersnaam": "gebruiker2",
               "test_wachtwoord": "wachtwoord"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "fout": {
               "code": -32500,
               "bericht": "Toepassingsfout.",
               "gegevens": "Onjuiste gebruikersnaam of wachtwoord of account is tijdelijk geblokkeerd."
           },
           "id": 1
       }
Test gebruikersmap voor gebruikersvoorziening

Test gebruikersmap "3" voor welke geconfigureerde gegevens overeenkomen met de gebruikersmap instellingen voor "gebruiker3" voorziening (bijv., welke gebruikersrol, gebruikersgroepen, gebruikersmedia zullen aan de gebruiker worden toegewezen).

Aanvraag:

{
           "jsonrpc": "2.0",
           "methode": "gebruikersmap.testen",
           "parameters": {
               "gebruikersmapid": "2",
               "host": "host.example.com",
               "poort": "389",
               "base_dn": "DC=zbx,DC=local",
               "zoek_attribuut": "sAMAccountName",
               "bind_dn": "CN=Beheerder,OU=Gebruikers,OU=Zabbix,DC=zbx,DC=local",
               "test_gebruikersnaam": "gebruiker3",
               "test_wachtwoord": "wachtwoord"
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "resultaat": {
               "gebruikersnaam": "gebruiker3",
               "naam": "John",
               "achternaam": "Doe",
               "medias": [],
               "usrgrps": [
                   {
                       "usrgrpid": "8"
                   },
                   {
                       "usrgrpid": "7"
                   }
               ],
               "rolid": "2",
               "gebruikersmapid": "2"
           },
           "id": 1
       }

Bron

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