userdirectory.test

Apraksts

object userdirectory.test(array userDirectory)

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

Šī metode ļauj arī pārbaudīt, kādi konfigurētie dati atbilst lietotāju direktorija iestatījumiem lietotāju nodrošināšanai (piemēram, kāda lietotāja loma, lietotāju grupas un lietotāja multivides tiks piešķirtas lietotājam). Šāda veida pārbaudei API pieprasījums jāveic lietotāju direktorijam, kuram provision_status ir iestatīts uz enabled.

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

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.
Papildus standarta lietotāju direktorija rekvizītiem metode pieņem šādus parametrus.

Parametrs Tips 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ā.

Atgrieztās vērtības

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

Piemēri

Pārbaudīt lietotāju direktoriju esošam lietotājam

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

Pieprasījums:

{
    "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:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}
Testēt lietotāju direktoriju neesošam lietotājam

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

Pieprasījums:

{
    "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:

{
    "jsonrpc": "2.0",
    "error": {
        "code": -32500,
        "message": "Application error.",
        "data": "Incorrect user name or password or account is temporarily blocked."
    },
    "id": 1
}
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:

{
    "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:

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

Avots

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