Documentation
Table of Contents
userdirectory.get
Descripción
integer/array userdirectory.get(object parameters)
El método permite recuperar directorios de usuarios según los parámetros dados.
Este método solo está disponible para los tipos de usuarios Superadministrador.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| userdirectoryids | ID/matriz | Devuelve solo directorios de usuarios con los ID proporcionados. |
| selectUsrgrps | query | Devuelve una propiedad usrgrps con grupos de usuarios asociado con un directorio de usuarios.Admite count. |
| selectProvisionMedia | consulta | Devuelve una propiedad provision_media con asignaciones de tipo de medio asociada con un directorio de usuario. |
| selectProvisionGroups | consulta | Devuelve una propiedad provision_groups con asignaciones de grupos de aprovisionamiento asociado con un directorio de usuario. |
| sortfield | cadena/matriz | Ordena el resultado según las propiedades dadas. Valores posibles: nombre. |
| filtro | objeto | Devuelve solo aquellos resultados que coinciden exactamente con el filtro dado. Acepta un objeto, donde las claves son nombres de propiedades y los valores son un valor único o una matriz de valores. Admite propiedades: userdirectoryid, idp_type, provision_status. |
| búsqueda | objeto | Devuelve resultados que coinciden con el patrón dado (no distingue entre mayúsculas y minúsculas). Acepta un objeto, donde las claves son nombres de propiedades y los valores son cadenas para buscar. Si no se proporcionan opciones adicionales, se realizará una búsqueda LIKE "%…%".Admite propiedades: nombre, descripción.El directorio de usuarios de tipo SAML tener un valor vacío para las propiedades nombre y descripción . Ambas propiedades se pueden cambiar con la operación userdirectory.update. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en el comentario de referencia. |
| excluirBuscar | booleano | |
| límite | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperar directorios de usuarios
Recupere todos los directorios de usuarios con propiedades adicionales que muestran asignaciones de tipos de medios y asignaciones de grupos de aprovisionamiento asociadas con cada directorio de usuarios.
{
"jsonrpc": "2.0",
"método": "directoriodeusuario.get",
"parámetros": {
"salida": "extender",
"selectProvisionMedia": "extender",
"selectProvisionGroups": "extender"
},
"identificación": 1
}Respuesta:
{
"jsonrpc": "2.0",
"resultado": [
{
"userdirectoryid": "1",
"idp_type": "2",
"nombre": "",
"provision_status": "1",
"descripción": "",
"group_name": "grupos",
"user_username": "",
"usuario_apellido": "",
"idp_entityid": "http://example.com/simplesaml/saml2/idp/metadata.php",
"sso_url": "http://example.com/simplesaml/saml2/idp/SSOService.php",
"slo_url": "",
"username_attribute": "uid",
"sp_entityid": "zabbix",
"nameid_format": "",
"sign_messages": "0",
"sign_assertions": "0",
"sign_authn_requests": "0",
"sign_logout_requests": "0",
"sign_logout_responses": "0",
"encrypt_nameid": "0",
"encrypt_assertions": "0",
"scim_status": "1",
"provision_media": [
{
"userdirectory_mediaid": "1",
"nombre": "ejemplo.com",
"mediatypeid": "1",
"atributo": "[email protected]",
"activo": "0",
"gravedad": "63",
"período": "1-7,00:00-24:00"
}
],
"grupos_aprovisionamiento": [
{
"nombre": "*",
"roleid": "1",
"Grupos de Usuarios": [
{
"usrgrpid": "13"
}
]
}
]
},
{
"userdirectoryid": "2",
"idp_type": "1",
"nombre": "servidor AD",
"provision_status": "1",
"descripción": "",
"host": "host.ejemplo.com",
"puerto": "389",
"base_dn": "DC=zbx,DC=local",
"search_attribute": "sAMAccountName",
"bind_dn": "CN=Admin,OU=Usuarios,OU=Zabbix,DC=zbx,DC=local",
"start_tls": "0",
"Filtro de búsqueda": "",
"group_basedn": "OU=Zabbix,DC=zbx,DC=local",
"nombre_grupo": "CN",
"group_member": "miembro",
"group_filter": "(%{groupattr}=CN=%{ref},OU=Usuarios,OU=Zabbix,DC=zbx,DC=local)",
"membresía de grupo": "",
"user_username": "nombre dado",
"user_lastname": "sn",
"user_ref_attr": "CN",
"provision_media": [
{
"userdirectory_mediaid": "2",
"nombre": "ejemplo.com",
"mediatypeid": "1",
"atributo": "[email protected]",
"activo": "0",
"gravedad": "63",
"período": "1-7,00:00-24:00"
}
],
"grupos_aprovisionamiento": [
{
"nombre": "*",
"roleid": "4",
"Grupos de Usuarios": [
{
"usrgrpid": "8"
}
]
},
{
"nombre": "Administradores de Zabbix",
"roleid": "2",
"Grupos de Usuarios": [
{
"usrgrpid": "7"
},
{
"usrgrpid": "8"
}
]
}
]
},
{
"userdirectoryid": "3",
"idp_type": "1",
"nombre": "Servidor API LDAP nº 1",
"provision_status": "0",
"descripción": "",
"host": "ldap://local.ldap",
"puerto": "389",
"base_dn": "ou=Usuarios,dc=ejemplo,dc=org",
"search_attribute": "uid",
"bind_dn": "cn=ldap_search,dc=ejemplo,dc=org",
"start_tls": "1",
"Filtro de búsqueda": "",
"group_basedn": "",
"Nombre del grupo": "",
"miembro del grupo": "",
"filtro_grupo": "",
"membresía de grupo": "",
"user_username": "",
"usuario_apellido": "",
"user_ref_attr": "",
"provision_media": [],
"grupos_aprovisionamiento": []
}
],
"identificación": 1
}Ver también
Fuente
CUserDirectory::get() en ui/include/classes/api/services/CUserDirectory.php.