Presentación

Esta API sustituye al anterior servicio SOAP.

Pretende abarcar todas las operaciones referentes al Metadirectorio.

Operaciones

Para saber las operaciones que se pueden realizar puedes consultar la descripción que se incluye a continuación o dirigirte al fichero WADL del servicio:

• Fichero WADL

• Listado de operaciones:

  Autenticación de usuario

  Controlador

  Usuarios.

  Operación

  Show .

  Id

  Login del usuario.

  Parámetros

  • password: Clave del usuario en base 64.

  Devuelve

  • Ok: Array( "usuario" => {...})
  • Usuario no encontrado: NULL

  Ejemplo

  /apiad/usuarios/LOGIN/?password=CLAVE_EN_BASE64

  Búsqueda por usuario o correo electrónico

  Controlador

  Usuarios.

  Operación

  Show .

  Id

  Nombre de usuario o correo electrónico.

  Parámetros

  show_entity: Si se indica devuelve el identificador de la entidad a la que pertenece el usurio, junto al resto de datos.

  Devuelve

  • Ok: Array( "usuario" => {...})
  • Usuario no encontrado: NULL

  Ejemplo

  /apiad/usuarios/LOGIN_O_EMAIL

  Búsqueda de usuarios por login

  Controlador

  Usuarios.

  Operación

  index .

  Parámetros

  • login: Nombre de usuario o parte del nombre de usuario que deben contener.

  Devuelve

  • Array( "logins" => "li,l2,l3,...")

  Ejemplo

  /apiad/usuarios/?login=LOGIN_BUSCADO

  Búsqueda de usuarios genérica (por login, nombre, empresa, teléfono o departamento).

  Controlador

  Usuarios.

  Operación

  index .

  Parámetros

  • user: Nombre de usuario o parte del nombre de usuario que deben contener los usuarios resultantes.
  • name: Nombre, apellido o parte del nombre o del apellido que deben contener los usuarios resultantes.
  • ou: Rama del directorio activo correspondiente a la empresa.
  • phone: Telefono a buscar.
  • department: Departamento dentro de la empresa buscar.

  Devuelve

  • Array( "usuarios" => "{sNombre: xxx, sApellidos: yyy,...},...")

  Ejemplo

  /apiad/usuarios/?user=LOGIN_BUSCADO&name=NOMBRE_BUSCADO&ou=RAMA_DE_LA_EMPRESA_BUSCADA

  Cambio de clave

  Controlador

  Usuarios.

  Operación

  Update .

  Id

  Login del usuario.

  Parámetros

  • oldpassword: Clave actual del usuario en base 64.
  • newpassword: Nueva clave para el usuario en base64.

  Devuelve

  • Ok: TRUE
  • Error: FALSE

  Ejemplo

  /apiad/usuarios/LOGIN/?oldpassword=CLAVE_ANTERIOR_EN_BASE64&newpassword=NUEVA_CLAVE_EN_BASE_64

  Actualización de los datos de un usuario

  Controlador

  Usuarios.

  Operación

  Update .

  Id

  Login del usuario.

  Parámetros

  • sTelefono: Nuevo teléfono para el usuario.
  • sTelefonoMovil: Nuevo teléfono móvil para el usuario.
  • employeeType: Estado del usuario.
  • sEmail: Correo Electrónico del usuario.
  • extensionAttribute9: Nuevo movil .

  Devuelve

  • Ok: TRUE
  • Error: FALSE

  Ejemplo

  /apiad/usuarios/LOGIN/?sTelefono=NUEVOTELEFONO&sTelefonoMovil=NUEVOTELEFONOMOVIL&employeeType=NUEVOESTADO&extensionAttribute9=NUEVOMOVIL

  Obtener listado de organizaciones

  Controlador

  Usuarios.

  Operación

  GET .

  Parámetros

  • organizations: 1

  Devuelve

  • array de organizaciones de AD
  • array vacio

  Ejemplo

  /apiad/Usuarios?organizations=1

  Obtener listado de departamentos por organización

  Controlador

  Usuarios.

  Operación

  GET .

  Parámetros

  • departments:1
  • ou: la organización de la que va a obtener los departamentos

  Devuelve

  • array de departamentos por organización de AD
  • null

  Ejemplo

  /apiad/Usuarios?departments=1&ou=eprinsa