[comment]: # translation:outdated

[comment]: # ({caf91c6b-f9e8f670})
# userdirectory.test

[comment]: # ({/caf91c6b-f9e8f670})

[comment]: # ({99f1236b-b5ff62ed})
### Apraksts

`object userdirectory.test(array userDirectory)`

Šī metode ļauj pārbaudīt lietotāju direktorija savienojuma iestatījumus.

::: noteclassic
Šī metode arī ļauj pārbaudīt, kā konfigurētie dati atbilst lietotāju direktorija iestatījumiem lietotāju nodrošināšanai
(piemēram, kāda lietotāja loma, lietotāju grupas, lietotāja mediji tiks piešķirti lietotājam).
Šāda veida pārbaudei API pieprasījums jāveic [lietotāju direktorijam](/manual/api/reference/userdirectory/object#userdirectory), kuram `provision_status` ir iestatīts kā enabled.
:::

::: noteclassic
Šī metode ir pieejama tikai *Super admin* lietotāja tipam.
:::

[comment]: # ({/99f1236b-b5ff62ed})

[comment]: # ({72d24aee-d99c84a0})
### Parametri

`(object)` Lietotāju direktorija rekvizīti.

Tā kā `userdirectory.get` API neatgriež lauku `bind_password`, ir jānorāda `userdirectoryid` un/vai `bind_password`.<br>
Papildus [standarta lietotāju direktorija rekvizītiem](object#userdirectory) metode pieņem šādus parametrus.

|Parametrs|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|test_username|string|Lietotājvārds testēšanai lietotāju direktorijā.|
|test_password|string|Ar lietotājvārdu saistītā parole testēšanai lietotāju direktorijā.|

[comment]: # ({/72d24aee-d99c84a0})

[comment]: # ({0a19e6a5-99a75467})
### Atgrieztās vērtības

`(bool)` Veiksmes gadījumā atgriež true.

[comment]: # ({/0a19e6a5-99a75467})

[comment]: # ({b41637d2-47b9eb66})
### Piemēri

[comment]: # ({/b41637d2-47b9eb66})

[comment]: # ({0ec66727-9f73d089})
##### Pārbaudīt lietotāju direktoriju esošam lietotājam

Pārbaudiet lietotāju direktoriju "3" lietotājam "user1".

[Pieprasījums](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "userdirectory.test",
    "params": {
        "userdirectoryid": "3",
        "host": "127.0.0.1",
        "port": "389",
        "base_dn": "ou=Users,dc=example,dc=org",
        "search_attribute": "uid",
        "bind_dn": "cn=ldap_search,dc=example,dc=org",
        "bind_password": "password",
        "test_username": "user1",
        "test_password": "password"
    },
    "id": 1
}
```

Atbilde:

```json
{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}
```

[comment]: # ({/0ec66727-9f73d089})

[comment]: # ({fa573532-a8a25347})
##### Testēt lietotāju direktoriju neesošam lietotājam

Testēt lietotāju direktoriju "3" neesošam lietotājam "user2".

[Pieprasījums](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "userdirectory.test",
    "params": {
        "userdirectoryid": "3",
        "host": "127.0.0.1",
        "port": "389",
        "base_dn": "ou=Users,dc=example,dc=org",
        "search_attribute": "uid",
        "bind_dn": "cn=ldap_search,dc=example,dc=org",
        "test_username": "user2",
        "test_password": "password"
    },
    "id": 1
}
```

Atbilde:

```json
{
    "jsonrpc": "2.0",
    "error": {
        "code": -32500,
        "message": "Application error.",
        "data": "Incorrect user name or password or account is temporarily blocked."
    },
    "id": 1
}
```

[comment]: # ({/fa573532-a8a25347})

[comment]: # ({79a981ca-54c18b14})
##### Pārbaudīt lietotāju direktoriju lietotāju nodrošināšanai

Pārbaudīt lietotāju direktoriju "3", lai noskaidrotu, kādi konfigurētie dati atbilst lietotāju direktorija iestatījumiem lietotāja "user3" nodrošināšanai
(piemēram, kāda lietotāja loma, lietotāju grupas, lietotāja mediji tiks piešķirti lietotājam).

[Pieprasījums](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "userdirectory.test",
    "params": {
        "userdirectoryid": "2",
        "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",
        "test_username": "user3",
        "test_password": "password"
    },
    "id": 1
}
```

Atbilde:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "username": "user3",
        "name": "John",
        "surname": "Doe",
        "medias": [],
        "usrgrps": [
            {
                "usrgrpid": "8"
            },
            {
                "usrgrpid": "7"
            }
        ],
        "roleid": "2",
        "userdirectoryid": "2"
    },
    "id": 1
}
```

[comment]: # ({/79a981ca-54c18b14})

[comment]: # ({e28d4bf9-0402a0f4})
### Avots

CUserDirectory::test() failā *ui/include/classes/api/services/CUserDirectory.php*.

[comment]: # ({/e28d4bf9-0402a0f4})