userdirectory.create

Descripción

object userdirectory.create(object/array userDirectory)

Este método permite crear nuevos directorios de usuarios.

Este método solo está disponible para el tipo de usuario Super administrador.

Parámetros

(objeto/matriz) Directorios de usuarios a crear.

El método acepta directorios de usuarios con las propiedades estándar del [directorio de usuarios] (object#userdirectory).

Valores de retorno

(objeto) Devuelve un objeto que contiene los ID de los directorios de usuarios creados bajo la propiedad userdirectoryids. El orden de los ID devueltos coincide con el orden de los directorios de usuarios pasados.

Ejemplos

Creando un directorio de usuarios

Cree un directorio de usuarios para autenticar usuarios con StartTLS sobre LDAP. Tenga en cuenta que para autenticar usuarios a través de LDAP, se debe habilitar la autenticación LDAP.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "userdirectory.create",
           "params": {
               "idp_type": "1",
               "name": "LDAP API server #1",
               "host": "ldap://local.ldap",
               "port": "389",
               "base_dn": "ou=Users,dc=example,dc=org",
               "bind_dn": "cn=ldap_search,dc=example,dc=org",
               "bind_password": "ldapsecretpassword",
               "search_attribute": "uid",
               "start_tls": "1"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": {
               "userdirectoryids": [
                   "3"
               ]
           },
           "id": 1
       }
Creación de un directorio de usuarios (aprovisionamiento JIT habilitado)

Cree un directorio de usuarios para autenticar usuarios a través de LDAP (con el aprovisionamiento JIT habilitado). Tenga en cuenta que para autenticar usuarios a través de LDAP, se debe habilitar la autenticación LDAP.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "userdirectory.create",
           "params": {
                   "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=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local",
                   "start_tls": "0",
                   "search_filter": "",
                   "group_basedn": "OU=Zabbix,DC=zbx,DC=local",
                   "group_name": "CN",
                   "group_member": "member",
                   "group_filter": "(%{groupattr}=CN=%{ref},OU=Users,OU=Zabbix,DC=zbx,DC=local)",
                   "group_membership": "",
                   "user_username": "givenName",
                   "user_lastname": "sn",
                   "user_ref_attr": "CN",
                   "provision_media": [
                       {
                           "name": "example.com",
                           "mediatypeid": "1",
                           "attribute": "[email protected]"
                       }
                   ],
                   "provision_groups": [
                       {
                           "name": "*",
                           "roleid": "4",
                           "user_groups": [
                               {
                                   "usrgrpid": "8"
                               }
                           ]
                       },
                       {
                           "name": "Zabbix administrators",
                           "roleid": "2",
                           "user_groups": [
                               {
                                   "usrgrpid": "7"
                               },
                               {
                                   "usrgrpid": "8"
                               }
                           ]
                       }
                   ]
               },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": {
               "userdirectoryids": [
                   "2"
               ]
           },
           "id": 1
       }

Fuente

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