Auth samples

Aspectos básicos

La clase com.openkm.sdk4csharp.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian o consultan los permisos de seguridad.

Consejo

Para establecer acceso de lectura y escritura (READ y WRITE) debe hacer:

int permission = Permission.READ + Permission.WRITE;

Para comprobar si dispone de un permiso, debe hacer:

// permission is a valid integer value
if ((permission | Permission.WRITE) = Permission.WRITE) {
  // Has WRITE grants.
}

En casi todos los métodos, verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID de nodo válido (carpeta, documento, correo, expediente) o una ruta de nodo.

Consejo

Ejemplo de nodeId:

• Usando UUID -> “c41f9ea0-0d6c-45da-bae4-d72b66f42d0f”;

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el webservice, la sesión se mantiene en el objeto webservice. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto puede usar todos los métodos de Auth de la clase “auth”, tal y como se muestra a continuación:

Dictionary<String, int> grants = ws.auth.getGrantedRoles("373bcdd0-c082-4e7b-addd-e10ef813946e");

Métodos

login

Descripción:

Método	Valores de retorno	Descripción
login(String personalAccessToken)	String	Devuelve el token de acceso autorizado.

Nota

El token de acceso tiene, por defecto, un tiempo de expiración de 24 horas.

Tras ejecutar el método login, todas las llamadas posteriores usarán automáticamente el token de autenticación.

Cada vez que se ejecuta el método login, el token de acceso se sustituye por uno nuevo.

Peligro

Cuando un usuario accede a la aplicación por primera vez, se invoca internamente un método que crea las carpetas propias de ese usuario, como /okm:trash/userId, etc.

Desde el punto de vista de la API, este método solo debería ejecutarse la primera vez que un usuario accede a la API, para crear la estructura de carpetas propia de ese usuario.

De lo contrario pueden producirse errores, por ejemplo PathNotExistsException /okm:trash/userId al eliminar objetos, porque las carpetas no se han llegado a crear.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                String personalAccessToken = "okmpat-ZRjVfMBcCp2tB1T2Dzbq";
                ws.login(personalAccessToken);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

login

Descripción:

Método	Valores de retorno	Descripción
login(String user, String password)	String	Devuelve el token de acceso autorizado.

Nota

El token de acceso tiene, por defecto, un tiempo de expiración de 24 horas.

Tras ejecutar el método login, todas las llamadas posteriores usarán automáticamente el token de autenticación.

Cada vez que se ejecuta el método login, el token de acceso se sustituye por uno nuevo.

Peligro

Cuando un usuario accede a la aplicación por primera vez, se invoca internamente un método que crea las carpetas propias de ese usuario, como /okm:trash/userId, etc.

Desde el punto de vista de la API, este método solo debería ejecutarse la primera vez que un usuario accede a la API, para crear la estructura de carpetas propia de ese usuario.

De lo contrario pueden producirse errores, por ejemplo PathNotExistsException /okm:trash/userId al eliminar objetos, porque las carpetas no se han llegado a crear.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

login

Descripción:

Método	Valores de retorno	Descripción
String login(String user, String password, int expiration, bool restrictIp)	String	El proceso de login devuelve el token de autenticación.

Nota

El token de acceso tiene, por defecto, un tiempo de expiración variable definido en días.

Cuando restrictIP es true, el token solo funcionará desde la dirección IP de origen.

Tras ejecutar el método login, todas las llamadas posteriores usarán automáticamente el token de autenticación.

Cada vez que se ejecuta el método login, el token de acceso se sustituye por uno nuevo.

Peligro

Cuando un usuario accede a la aplicación por primera vez, se invoca internamente un método que crea las carpetas propias de ese usuario, como /okm:trash/userId, etc.

Desde el punto de vista de la API, este método solo debería ejecutarse la primera vez que un usuario accede a la API, para crear la estructura de carpetas propia de ese usuario.

De lo contrario pueden producirse errores, por ejemplo PathNotExistsException /okm:trash/userId al eliminar objetos, porque las carpetas no se han llegado a crear.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            int days = 7;
            bool restrictIp = true;
            try
            {
                System.Console.WriteLine("Token: " + ws.login(user, password, days, restrictIp));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

logout

Descripción:

Método	Valores de retorno	Descripción
logout()	void	Ejecuta el método logout en el lado de OpenKM.

Precaución

El token de autenticación se reiniciará.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
           String host = "http://localhost:8080/openkm";
           String username = "okmAdmin";
           String password = "admin";
           OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

           try
           {
              ws.login(user, password);
              ws.logout();
           }
           catch (Exception e)
           {
              System.Console.WriteLine(e.ToString());
           }
        }
    }
}

getRefreshToken

Descripción:

Método	Valores de retorno	Descripción
getRefreshToken()	String	Renueva el token de autenticación actual.

Nota

Al iniciar sesión, se establece un token de autenticación en el OKMWebservice. Por defecto, el token de autenticación expira a las 24 horas. Este método permite sustituir el token actual por uno nuevo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {
                ws.login(user, password);
                String token = ws.getRefreshToken();
                System.Console.WriteLine("New token : " + token);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getGrantedRoles

Descripción:

Método	Valores de retorno	Descripción
getGrantedRoles(String nodeId)	Dictionary<String, int>	Devuelve los roles con permisos concedidos sobre un nodo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {
                ws.login(user, password);
                Dictionary<String, int> grants = ws.auth.getGrantedRoles("14530e37-ac51-4a26-8049-0146a5916dec");
                foreach (String role in grants.Keys)
                {
                     System.Console.WriteLine("role ->" + role);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getGrantedUsers

Descripción:

Método	Valores de retorno	Descripción
getGrantedUsers(String nodeId)	Dictionary<String, int>	Devuelve los usuarios con permisos concedidos sobre un nodo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Dictionary<String, int> grants = ws.auth.getGrantedUsers("14530e37-ac51-4a26-8049-0146a5916dec");
                foreach (KeyValuePair<string, int> kvp in grants)
                {
                    Console.WriteLine("{0} -> {1}", kvp.Key, kvp.Value);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRoles

Descripción:

Método	Valores de retorno	Descripción
getRoles(boolean showAll)	List	Devuelve la lista de todos los roles.

Cuando la variable showAll es true, devuelve todos los roles -habilitados y deshabilitados-; en caso contrario, solo devuelve los habilitados.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
               ws.login(user, password);
               foreach (String role in ws.auth.getRoles(false))
               {
                   System.Console.WriteLine(role);
               }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRolesByUser

Descripción:

Método	Valores de retorno	Descripción
getRolesByUser(String user)	List	Devuelve la lista de todos los roles asignados a un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                foreach(String role in ws.auth.getRolesByUser("okmAdmin"))
                {
                    System.Console.WriteLine(role);
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUser

Descripción:

Método	Valores de retorno	Descripción
getUser(String userId)	CommonUser	Devuelve un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                CommonUser user = ws.auth.getUser("okmAdmin");
                System.Console.WriteLine(user.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUsers

Descripción:

Método	Valores de retorno	Descripción
getUsers(boolean showAll)	List	Devuelve la lista de todos los usuarios.

Cuando la variable showAll es true, devuelve todos los usuarios -habilitados y deshabilitados-; en caso contrario, solo devuelve los habilitados.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                foreach (CommonUser user in ws.auth.getUsers(false))
                {
                    System.Console.WriteLine(user.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUsersByRole

Descripción:

Método	Valores de retorno	Descripción
getUsersByRole(String roleId)	List	Devuelve la lista de todos los usuarios que tienen asignado un rol.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                foreach (CommonUser user in ws.auth.getUsersByRole("ROLE_ADMIN"))
                {
                    System.Console.WriteLine(user.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

revokeRole

Descripción:

Método	Valores de retorno	Descripción
revokeRole(String nodeId, String role, int permissions, boolean recursive)	void	Elimina el permiso concedido a un rol sobre un nodo.

El parámetro recursive solo tiene sentido cuando nodeId es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                // Remove ROLE_USER write grants at the node but not descendants
                ws.auth.revokeRole("14530e37-ac51-4a26-8049-0146a5916dec", "ROLE_USER", Permission.ALL_GRANTS, false);

                // Remove all ROLE_ADMIN grants to the node and descendants
                ws.auth.revokeRole("14530e37-ac51-4a26-8049-0146a5916dec", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

revokeUser

Descripción:

Método	Valores de retorno	Descripción
revokeUser(String nodeId, String user, int permissions, boolean recursive)	void	Elimina el permiso concedido a un usuario sobre un nodo.

El parámetro recursive solo tiene sentido cuando nodeId es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                // Remove john write grants at the node but not descendants
                ws.auth.revokeUser("14530e37-ac51-4a26-8049-0146a5916dec", "john", Permission.ALL_GRANTS, false);

                // Remove all okmAdmin grants at the node and descendants
                ws.auth.revokeUser("14530e37-ac51-4a26-8049-0146a5916dec", "okmAdmin", Permission.ALL_GRANTS, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

grantRole

Descripción:

Método	Valores de retorno	Descripción
grantRole(String nodeId, String role, int permissions, boolean recursive)	void	Añade un permiso concedido a un rol sobre un nodo.

El parámetro recursive solo tiene sentido cuando nodeId es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                // Add ROLE_USER write grants at the node but not descendants
                ws.auth.grantRole("14530e37-ac51-4a26-8049-0146a5916dec", "ROLE_USER", Permission.ALL_GRANTS, false);

                // Add all ROLE_ADMIN grants to the node and descendants
                ws.auth.grantRole("14530e37-ac51-4a26-8049-0146a5916dec", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

grantUser

Descripción:

Método	Valores de retorno	Descripción
grantUser(String nodeId, String userId, int permissions, boolean recursive)	void	Añade un permiso concedido a un usuario sobre un nodo.

El parámetro recursive solo tiene sentido cuando nodeId es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                // Add john write grants at the node but not descendants
                ws.auth.grantUser("14530e37-ac51-4a26-8049-0146a5916dec", "john", Permission.ALL_GRANTS, false);

                // Add all okmAdmin grants at the node and descendants
                ws.auth.grantUser("14530e37-ac51-4a26-8049-0146a5916dec", "okmAdmin", Permission.ALL_GRANTS, true);
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getProfiles

Descripción:

Método	Valores de retorno	Descripción
getProfiles(boolean filterByActive)	List	Devuelve la lista de todos los perfiles.

Cuando el parámetro filterByActive está activado, el método devuelve solo los perfiles activos; en caso contrario, devuelve todos los perfiles disponibles.

Nota

A cada usuario se le asigna un perfil que habilita más o menos funcionalidades de la interfaz de OpenKM.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                foreach (Profile profile in ws.auth.getProfiles(true))
                {
                   System.Console.WriteLine(profile.toString());
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getUserProfile

Descripción:

Método	Valores de retorno	Descripción
getUserProfile(String userId)	Profile	Devuelve el perfil asignado a un usuario.

Nota

A cada usuario se le asigna un perfil que habilita más o menos funcionalidades de la interfaz de OpenKM.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                System.Console.WriteLine(ws.auth.getUserProfile("okmAdmin").toString());
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setUserProfile

Descripción:

Método	Valores de retorno	Descripción
setUserProfile(String userId, long profileId)	void	Cambia el perfil asignado a un usuario.

Nota

A cada usuario se le asigna un perfil que habilita más o menos funcionalidades de la interfaz de OpenKM.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                // Set the profile named "default" to the user
                foreach (Profile profile in ws.auth.getProfiles(true))
                {
                    if (profile.name.Equals("Default"))
                    {
                        ws.setUserProfile("okmAdmin", profile.id);
                    }
                }
            } catch (Exception e) {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createUser

Descripción:

Método	Valores de retorno	Descripción
createUser(String user, String password, String email, String name, Boolean active)	void	Crea un nuevo usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.createUser("test", "password.2016", "some@mail.com", "User Name", true);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteUser

Descripción:

Método	Valores de retorno	Descripción
deleteUser(String userId)	void	Elimina un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.deleteUser("test");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateUser

Descripción:

Método	Valores de retorno	Descripción
updateUser(String userId, String password, String email, String name, Boolean active)	void	Actualiza un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.updateUser("test", "newpassword", "some@mail.com", "Test", false);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createRole

Descripción:

Método	Valores de retorno	Descripción
createRole(String roleId, boolean active)	void	Crea un nuevo rol.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.createRole("ROLE_TEST", true);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteRole

Descripción:

Método	Valores de retorno	Descripción
deleteRole(String roleId)	void	Elimina un rol.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.deleteRole("ROLE_TEST");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateRole

Descripción:

Método	Valores de retorno	Descripción
updateRole(String roleId, boolean active)	void	Actualiza un rol.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.updateRole("ROLE_TEST", true);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

assignRole

Descripción:

Método	Valores de retorno	Descripción
assignRole(String userId, String roleId)	void	Asigna un rol a un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.assignRole("test", "ROLE_USER");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

removeRole

Descripción:

Método	Valores de retorno	Descripción
removeRole(String userId, String roleId)	void	Elimina un rol de un usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                ws.auth.removeRole("test", "ROLE_USER");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

changeSecurity

Descripción:

Método	Valores de retorno	Descripción
changeSecurity(ChangeSecurity changeSecurity)	void	Cambia la seguridad de un nodo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Folder fld = ws.folder.createFolder("a978f8e6-aa87-4f0f-b7bc-6f44cb090fdf", "Folder1");
                ChangeSecurity cs = new ChangeSecurity();
                List<GrantedRole> grList = new List<GrantedRole>();
                GrantedRole gr = new GrantedRole();
                gr.role = "ROLE_TEST";
                gr.permissions = Permission.READ | Permission.WRITE;
                grList.Add(gr);
                cs.grantedRolesList = grList;
                ws.auth.changeSecurity(fld.uuid, cs);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

overwriteSecurity

Descripción:

Método	Valores de retorno	Descripción
overwriteSecurity(String uuid, ChangeSecurity changeSecurity)	void	Sobrescribe la seguridad de un nodo.

Precaución

El objeto ChangeSecurity se usa en los métodos changeSecurity y overwriteSecurity.

Aunque los valores establecidos en las variables revokeUsers y revokeRoles del objeto ChangeSecurity estén presentes, no se tendrán en cuenta al sobrescribir la seguridad.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                GrantedUser gu = new GrantedUser();
                gu.user = pherrera;
                gu.permissions = Permission.READ | Permission.WRITE;

                List<GrantedUser> guList = new List<GrantedUser>();
                guList.Add(gu);

                GrantedRole gr = new GrantedRole();
                gr.role = "ROLE_TEST";
                gr.permissions = Permission.READ | Permission.WRITE;

                List<GrantedRole> grList = new List<GrantedRole>();
                grList.Add(gr);

                ChangeSecurity changeSecurity = new ChangeSecurity();
                changeSecurity.recursive = false;
                changeSecurity.grantedUsersList = guList;
                changeSecurity.grantedRolesList = grList;

                ws.auth.overwriteSecurity("4f873d10-654e-4d99-a94f-15466e30a0f6", changeSecurity);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getGrantedUsersAndRoles

Descripción:

Método	Valores de retorno	Descripción
getGrantedUsersAndRoles(String uuid)	GrantedUsersAndRolesItem	Devuelve los usuarios y roles con permisos concedidos sobre un nodo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
              String host = "http://localhost:8080/openkm";
              String username = "okmAdmin";
              String password = "admin";
              OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

              try
              {
                  ws.login(user, password);
                  GrantedUsersAndRolesItem grants = ws.auth.getGrantedUsersAndRoles("15e35aef-f1bb-451e-ac86-3b0f7c88ca9f");
                  foreach (KeyValuePair<string, int> user in grants.grantedUsers)
                  {
                       System.Console.WriteLine(user.Key + "->" + user.Value);
                  }
                  foreach (KeyValuePair<string, int> role in grants.grantedRoles)
                  {
                       System.Console.WriteLine(role.Key + "->" + role.Value);
                  }
              }
              catch (Exception e)
              {
                  System.Console.WriteLine(e.ToString());
              }
         }
    }
}

setUserPermissions

Descripción:

Método	Valores de retorno	Descripción
setUserPermissions(String uuid, String userId, int permissions, bool recursive)	void	Actualiza los permisos de un usuario sobre un nodo.

El parámetro recursive solo tiene sentido cuando uuid es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 // Set user permissions
                 ws.auth.setUserPermissions("22c1d190-f798-489d-b420-2008cb38705b", "user1", Permission.READ + Permission.WRITE, false);

                 // Update permissions of okmAdmin at the node and descendants
                 ws.auth.setUserPermissions("22c1d190-f798-489d-b420-2008cb38705b", "okmAdmin", Permission.ALL_GRANTS, true);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
         }
     }
}

setRolePermissions

Descripción:

Método	Valores de retorno	Descripción
setRolePermissions(String uuid, String roleId, int permissions, bool recursive)	void	Actualiza los permisos de un rol sobre un nodo.

El parámetro recursive solo tiene sentido cuando uuid es una carpeta o un expediente.

Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
   public class Program
   {
       static void Main(string[] args)
       {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                 ws.login(user, password);
                 // Set role permissions
                 ws.auth.setRolePermissions("22c1d190-f798-489d-b420-2008cb38705b", "ROLE_USER", Permission.READ + Permission.WRITE, false);

                 // Update permissions of ROLE_ADMIN at the node and descendants
                 ws.auth.setRolePermissions("22c1d190-f798-489d-b420-2008cb38705b", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

getUserTenants

Descripción:

Método	Valores de retorno	Descripción
getUserTenants()	List	Devuelve la lista de todos los tenants.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
               String host = "http://localhost:8080/openkm";
               String username = "okmAdmin";
               String password = "admin";
               OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

               try
               {
                   ws.login(user, password);
                   List<Tenant> tenants = ws.auth.getUserTenants();
                   foreach (Tenant tenant in tenants)
                   {
                       System.Console.WriteLine(tenant.toString());
                   }
               }
               catch (Exception e)
               {
                   System.Console.WriteLine(e.ToString());
               }
         }
    }
}

setUserTenant

Descripción:

Método	Valores de retorno	Descripción
setUserTenant(long tenantId)	void	Cambia el tenant asignado a un usuario.

Nota

Un usuario puede tener acceso a varios tenants, pero solo tener uno asignado.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 long tenantId = 1; // Valid tenant id
                 ws.auth.setUserTenant(tenantId);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

isAdmin

Descripción:

Método	Valores de retorno	Descripción
isAdmin()	bool	Comprueba si el usuario autenticado pertenece a los administradores.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 bool isAdmin = ws.auth.isAdmin();
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

getSessionId

Descripción:

Método	Valores de retorno	Descripción
getSessionId()	String	Obtiene el ID de sesión HTTP.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 String id = ws.auth.getSessionId();
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

hasSecurityRecursive

Descripción:

Método	Valores de retorno	Descripción
hasSecurityRecursive()	bool	Comprueba si el usuario tiene permiso para propagar la seguridad de forma recursiva.

Nota

El rol se establece en el parámetro de configuración llamado “default.security.recursive.role”.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 bool hasSecurityRecursive = ws.auth.hasSecurityRecursive();
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

hasTaskManagerAdmin

Descripción:

Método	Valores de retorno	Descripción
hasTaskManagerAdmin()	bool	Comprueba si el usuario pertenece al rol “task manager admin”.

Nota

El parámetro de configuración llamado “default.task.manager.admin.role” se usa para indicar el rol.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 bool hasSecurityRecursive = ws.auth.hasTaskManagerAdmin();
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

isLoginLowercase

Descripción:

Método	Valores de retorno	Descripción
isLoginLowercase()	bool	Devuelve true cuando el login del usuario debe estar en minúsculas.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 System.Console.WriteLine(ws.auth.isLoginLowercase().ToString());
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

isPasswordExpired

Descripción:

Método	Valores de retorno	Descripción
isPasswordExpired()	Boolean	True cuando la contraseña del usuario ha expirado.

Nota

Por defecto, la expiración de contraseña está deshabilitada. Consulte el parámetro de configuración llamado “user.password.expiration” en la sección Security configuration parameters para habilitarla.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 System.Console.WriteLine("Password expired= " + ws.auth.isPasswordExpired().ToString());
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

getUserToken

Descripción:

Método	Valores de retorno	Descripción
getUserToken(String userId)	String	Devuelve el token de autenticación de un usuario dado.

Precaución

Esta acción solo puede realizarla un superusuario (un usuario con ROLE_ADMIN).

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 String userToken = ws.auth.getUserToken("testUser");
                 Console.WriteLine("UserToken: " + userToken);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

getUserToken

Descripción:

Método	Valores de retorno	Descripción
getUserToken(String userId, int expiration, bool restrictIp)	String	Devuelve el token de autenticación de un usuario dado.

Precaución

Esta acción solo puede realizarla un superusuario (un usuario con ROLE_ADMIN).

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";
             String username = "okmAdmin";
             String password = "admin";
             OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

             try
             {
                 ws.login(user, password);
                 String userToken = ws.auth.getUserToken("testUser", 7, true);
                 Console.WriteLine("UserToken: " + userToken);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

createPersonalAccessToken

Descripción:

Método	Valores de retorno	Descripción
createPersonalAccessToken(String name, DateTime expiration)	String	Devuelve el token de acceso personal.

Nota

Puede generar un token de acceso personal para cada aplicación que necesite acceder a la API.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
     public class Program
     {
         static void Main(string[] args)
         {
             String host = "http://localhost:8080/openkm";

             try
             {
                  DateTime today = DateTime.Now;
                  DateTime futureDate = today.AddDays(365);// create an expired token
                  String personalAccessToken = ws.auth.createPersonalAccessToken("good-pat-test", futureDate);
                  OKMWebservices ws= OKMWebservicesFactory.newInstance(Config.HOST);
                  ws.login(personalAccessToken);
             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}