API del Servicio Web del Directorio

Métodos de Identidad

En este grupo se incluyen aquellos métodos que permiten buscar y modificar identidades en el directorio. Las identidades sólo pueden ser creadas por las fuentes autoritativas. Sólo los atributos que no proceden de fuente autoritativa podrán ser modificados por aplicaciones externas.

Existen dos métodos básicos de consulta de identidad, que devuelve una identidad a partir de su identificador. Uno de los métodos devolverá una identidad con sus atributos básicos y el otro método con los atributos completos. El tercer método realiza una búsqueda en el Directorio y devuelve aquellas entradas que cumplan los criterios.

Métodos de grupo

Aquí se incluyen los métodos de acceso a los distintos grupos que existen en el directorio. Dentro del directorio tenemos grupos de Unidades Operativas (UO) y Grupos de Trabajo.

Para los Grupos de Unidades Operativas sólo se tendrán métodos para obtener las identidades y responsables de un grupo y para buscar grupos. Para los Grupos de Trabajo se tendrán también métodos de añadir/quitar identidades del grupo, crear/modificar/eliminar grupos.

Unidades Operativas

Sobre los Grupos de Unidades Operativas (UO) sólo existen operaciones de consulta. La operación de obtener los miembros de una UO, indicando si se devuelven los miembros del grupo o los responsables del grupo, si se obtienen los internos, externos o ambos. La operación de buscar UO según algún criterio, por ejemplo aquellas UO a las que pertenece determinado usuario o de las que es responsable determinado usuario.

Grupos de Trabajo

Sobre los Grupos de Trabajo se tienen varias operaciones que permiten las mismas funciones que sobre los grupos de UO y aparte realizar búsquedas, obtener usuarios y añadir/eliminar/modificar grupos, añadir/quitar usuarios de grupos.

Métodos de Organismo

Aquí se incluye el método de consulta sobre organismos.

Métodos de Aplicación

Las aplicaciones pueden leer y escribir atributos propios o comunes a todas las aplicaciones. Los atributos pueden estar tanto en la rama “común”, para las aplicaciones horizontales, como en la rama de cada organismo. Estos atributos pueden ser propios para cada aplicación o bien comunes a todas las aplicaciones que tengan los permisos necesarios.

Los atributos constarán de un par nombre-valor. Además del nombre del atributo en el mensaje tanto de escritura como de lectura hay que especificar si es un parámetro común o propio de la aplicación.

Método de Administración

Apéndice 1: Paginación

Todos los métodos que devuelvan lista serán susceptibles de ser paginados. En estos casos cuando el cliente realice la petición al Servicio Web indicará un número máximo de resultados, tamaño de la página, y un “ticket”. El ticket consiste en una cadena que hace referencia a una petición anterior. En caso de que sea la primera petición este ticket tendrá un valor nulo.

Cuando el sistema realice la operación y devuelva el resultado también devolverá un nuevo ticket. Este nuevo ticket deberá ser enviado para obtener los resultados de la siguiente página. De esta forma si realizamos una petición indicando que se obtengan los 100 primeros resultados de una lista para obtener los 100 siguientes debemos realizar otra petición pasando como parámetro el ticket anterior.

Apéndice 2: Consulta de Identidades

Muchos de los métodos de consulta de identidad permiten utilizar cualquiera de los identificadores de la identidad para realizar la consulta. Estos métodos reciben dos parámetros, uno con el tipo del identificador que se va a usar y otro con el valor de este.

El parámetro tipoIdentificador debe ser una de los siguientes valores:

El valor se corresponde con el valor del identificador por el cual queremos hacer la consulta. Por ejemplo para el método consultaIdentidadExt serían validas las siguientes llamadas:

• Identidad identidad = consultaIdentidadExt(“GUIA”, “100300007”);
• Identidad identidad = consultaIdentidadExt(“NIF”, “11111111B”);
• Identidad identidad = consultaIdentidadExt(“UID”, “jose.garcia”);