Áú»¢¶Ä²©

Esta es una traducci¨®n de la p¨¢gina de documentaci¨®n original en espa?ol. Ay¨²danos a mejorarla.

userdirectory.test

¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô

object userdirectory.test(array userDirectory)

Este m¨¦todo permite probar la configuraci¨®n de conexi¨®n del directorio de usuarios.

Este m¨¦todo tambi¨¦n permite probar qu¨¦ datos configurados coinciden con la configuraci¨®n del directorio de usuarios para el aprovisionamiento de usuarios. (por ejemplo, qu¨¦ rol de usuario, grupos de usuarios, medios de usuario se asignar¨¢n al usuario). Para este tipo de prueba, la solicitud de API debe realizarse para un directorio de usuarios que tenga el par¨¢metro provision_status configurado como habilitado.

Este m¨¦todo solo est¨¢ disponible para el tipo de usuario Super administrador.

±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ

(objeto) Propiedades del directorio de usuario.

Dado que la API userdirectory.get no devuelve el campo bind_password, se deben proporcionar userdirectoryid y/o bind_password.
Adem¨¢s de las propiedades est¨¢ndar del [directorio de usuarios] (object#userdirectory), el m¨¦todo acepta los siguientes par¨¢metros.

±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç Tipo ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
test_username cadena Nombre de usuario a probar en el directorio de usuarios.
test_password cadena Contrase?a asociada al nombre de usuario para probar en el directorio de usuarios.

Valores de retorno

(bool) Devuelve verdadero en caso de ¨¦xito.

Ejemplos

Pruebe el directorio de usuarios para el usuario existente

Pruebe el directorio de usuarios "3" para "usuario1".

Solicitud:

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

Respuesta:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }
Pruebe el directorio de usuarios para un usuario no existente

Pruebe el directorio de usuarios "3" para detectar si no existe un "usuario2".

Solicitud:

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

Respuesta:

{
           "jsonrpc": "2.0",
           "error": {
               "code": -32500,
               "message": "Application error.",
               "data": "Incorrect user name or password or account is temporarily blocked."
           },
           "id": 1
       }
Pruebe el directorio de usuarios para el aprovisionamiento de usuarios

Pruebe el directorio de usuarios "3" para ver qu¨¦ datos configurados coinciden con la configuraci¨®n del directorio de usuarios para el aprovisionamiento de "usuario3" (por ejemplo, qu¨¦ rol de usuario, grupos de usuarios, medios de usuario se asignar¨¢n al usuario).

Solicitud:

{
           "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=Áú»¢¶Ä²©,DC=zbx,DC=local",
               "test_username": "user3",
               "test_password": "password"
           },
           "id": 1
       }

Respuesta:

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

Fuente

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