OKMAuth

Se usa para gestionar la seguridad y los usuarios. Por ejemplo, añadir o eliminar permisos sobre un nodo, crear o modificar usuarios, u obtener los perfiles.

Precaución

A partir de la versión 8.1.14, algunos métodos devuelven el objeto DbUser en lugar del antiguo CommonUser, que ha quedado obsoleto.

Fundamentos

La clase com.openkm.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla en combinación con métodos que cambian u obtienen 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 tiene acceso de 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 o registro).

Consejo

Ejemplo de nodeId:

• Usando UUID -> “b153c4b7-3d1c-4589-bd42-0ed0f34fd338”;

Además, en todos los métodos verá un parámetro llamado “token”. Dado que las tareas de Cron se ejecutan en segundo plano sin autenticación, los métodos usados en este escenario podrían usar el parámetro token. Desde el contexto de ejecución por defecto de la aplicación, debe usar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Consejo

En casos especiales, puede ser “promovido a Administrador” usando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

login

Descripción:

Método	Valores devueltos	Descripción
login()	void	Simula el proceso de login del usuario desde la interfaz de usuario.

Nota

Cuando un usuario inicia sesión desde la interfaz, algún proceso en segundo plano crea los nodos principales del usuario, como /okm:trash. Desafortunadamente, si el usuario nunca ha iniciado sesión desde la interfaz e inicia sesión desde la API, estos nodos aún no se han creado y se generará un error, porque es necesario ejecutar primero el método login.

Precaución

El usuario debe estar autenticado antes de ejecutar el método.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.login();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

login

Descripción:

Método	Valores devueltos	Descripción
login(String user, String pass)	String	El proceso de login devuelve un token de autenticación.

Nota

Los tokens de login tienen por defecto un tiempo de expiración de 24 horas.

Después de 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 login se reemplaza por uno nuevo.

Peligro

Cuando un usuario inicia sesión en la aplicación por primera vez, se llama internamente a un método que crea las carpetas específicas del 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 específica del usuario.

De lo contrario, puede obtener errores, por ejemplo PathNotExistsException: /okm:trash/userId al eliminar objetos, porque las carpetas no se han creado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.login("userId","password");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

grantUser

Descripción:

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

• El parámetro recursive solo tiene sentido cuando el nodeId es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            // Add sochoa write grants at the node but not descendants
            okmAuth.grantUser(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "sochoa", Permission.ALL_GRANTS, false);

            // Add all okmAdmin grants at the node and descendants
            okmAuth.grantUser(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "okmAdmin", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

revokeUser

Descripción:

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

• El parámetro recursive solo tiene sentido cuando el nodeId es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            // Add sochoa write grants at the node but not descendants
            okmAuth.revokeUser(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "sochoa", Permission.ALL_GRANTS, false);

            // Remove all okmAdmin grants at the node and descendants
            okmAuth.revokeUser(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "okmAdmin", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGrantedUsers

Descripción:

Método	Valores devueltos	Descripción
getGrantedUsers(String token, String nodeId)	Map<String, Integer>	Devuelve los usuarios con permisos concedidos sobre un nodo.

Ejemplo:

package com.openkm;

import java.util.Map;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            Map<String, Integer> grants = okmAuth.getGrantedUsers(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338");
            for (String role : grants.keySet()) {
                System.out.println(role + "->" + grants.get(role));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

grantRole

Descripción:

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

• El parámetro recursive solo tiene sentido cuando el nodeId es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            // Add ROLE_USER write grants at the node but not descendants
            okmAuth.grantRole(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "ROLE_USER", Permission.ALL_GRANTS, false);

            // Add all ROLE_ADMIN grants to the node and descendants
            okmAuth.grantRole(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

revokeRole

Descripción:

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

• El parámetro recursive solo tiene sentido cuando el nodeId es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, el cambio se aplicará al nodo y a sus descendientes.

Ejemplo:

package com.openkm;
import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            // Remove ROLE_USER write grants at the node but not descendants
            okmAuth.revokeRole(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "ROLE_USER", Permission.ALL_GRANTS, false);

            // Remove all ROLE_ADMIN grants to the node and descendants
            okmAuth.revokeRole(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGrantedRoles

Descripción:

Método	Valores devueltos	Descripción
getGrantedRoles(String token, String nodeId)	Map<String, Integer>	Devuelve los roles con permisos concedidos sobre un nodo.

Ejemplo:

package com.openkm;

import java.util.Map;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            Map<String, Integer> grants = okmAuth.getGrantedRoles(null, "b153c4b7-3d1c-4589-bd42-0ed0f34fd338");
            for (String role : grants.keySet()) {
                System.out.println(role + "->" + grants.get(role));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUsers

Descripción:

Método	Valores devueltos	Descripción
getUsers(String token, boolean filterByActive)	List	Devuelve la lista de todos los usuarios. Cuando filterByActive es true, devuelve solo los usuarios activos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.DbUser;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            for (DbUser user : okmAuth.getUsers(null, true)) {
                System.out.println(user.getId());
                System.out.println(user.getName());
                System.out.println(user.getEmail());
                System.out.println(user.getActive());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRoles

Descripción:

Método	Valores devueltos	Descripción
getRoles(String token, boolean filterByActive)	List	Devuelve la lista de todos los roles. Cuando filterByActive es true, devuelve solo los roles activos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            for (String role : okmAuth.getRoles(null, true)) {
                System.out.println(role);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUsersByRole

Descripción:

Método	Valores devueltos	Descripción
getUsersByRole(String token, String role)	List	Devuelve la lista de todos los usuarios a los que se ha asignado un rol.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.DbUser;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            for (DbUser user : okmAuth.getUsersByRole(null, "ROLE_ADMIN")) {
                System.out.println(user.getId());
                System.out.println(user.getName());
                System.out.println(user.getEmail());
                System.out.println(user.getActive());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRolesByUser

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            for (String role : okmAuth.getRolesByUser(null, "okmAdmin")) {
                System.out.println(role);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

changeSecurity

Descripción:

Método	Valores devueltos	Descripción
public void changeSecurity(String token, String nodeId, Map<String, Integer> grantUsers, Map<String, Integer> revokeUsers, Map<String, Integer> grantRoles, Map<String, Integer> revokeRoles, boolean recursive)	void	Cambia la seguridad de un nodo.

Ejemplo:

package com.openkm;

import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            String nodeId = "b153c4b7-3d1c-4589-bd42-0ed0f34fd338";
            Map<String, Integer> grantUsers = new HashMap<>();
            Map<String, Integer> revokeUsers = new HashMap<>();
            Map<String, Integer> grantRoles = new HashMap<>();
            grantRoles.put("ROLE_TEST", Permission.READ | Permission.WRITE);
            Map<String, Integer> revokeRoles = new HashMap<>();
            okmAuth.changeSecurity(null, nodeId, grantUsers, revokeUsers, grantRoles, revokeRoles, false);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

overwriteSecurity

Descripción:

Método	Valores devueltos	Descripción
public void overwriteSecurity(String token, String nodeId, Map<String, Integer> grantUsers, Map<String, Integer> grantRoles, boolean recursive)	void	Sobrescribe la seguridad de un nodo.

Ejemplo:

package com.openkm;

import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            String nodeId = "b153c4b7-3d1c-4589-bd42-0ed0f34fd338";
            Map<String, Integer> grantUsers = new HashMap<>();
            Map<String, Integer> grantRoles = new HashMap<>();
            grantRoles.put("ROLE_TEST", Permission.READ | Permission.WRITE);
            okmAuth.overwriteSecurity(null, nodeId, grantUsers, grantRoles, false);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createUser

Descripción:

Método	Valores devueltos	Descripción
createUser(String token, DbUser user)	DbUser	Crea un nuevo usuario. Devuelve el objeto de usuario creado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.DbUser;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            DbUser user = new DbUser();
            user.setId("test");
            user.setPassword("password.2019");
            user.setEmail("some@mail.com");
            user.setName("User Name");
            user.setActive(true);
            DbUser created = okmAuth.createUser(null, user);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteUser

Descripción:

Método	Valores devueltos	Descripción
deleteUser(String token, String user)	void	Elimina un usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.deleteUser(null, "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateUser

Descripción:

Método	Valores devueltos	Descripción
updateUser(String token, DbUser user)	DbUser	Actualiza un usuario. Devuelve el objeto de usuario actualizado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.DbUser;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            DbUser user = new DbUser();
            user.setId("test");
            user.setPassword("newpassword");
            user.setEmail("some@mail.com");
            user.setName("Test");
            user.setActive(false);
            DbUser updated = okmAuth.updateUser(null, user);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createRole

Descripción:

Método	Valores devueltos	Descripción
createRole(String token, Role role)	void	Crea un nuevo rol.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Role;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            Role role = new Role();
            role.setId("ROLE_TEST");
            role.setActive(true);
            okmAuth.createRole(null, role);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteRole

Descripción:

Método	Valores devueltos	Descripción
deleteRole(String token, String role)	void	Elimina un rol.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.deleteRole(null, "ROLE_TEST");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

updateRole

Descripción:

Método	Valores devueltos	Descripción
updateRole(String token, String role, boolean active)	void	Actualiza un rol.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {
    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.updateRole(null, "ROLE_TEST", true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

assignRole

Descripción:

Método	Valores devueltos	Descripción
assignRole(String token, String user, String role)	void	Asigna un rol a un usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.assignRole(null, "test", "ROLE_USER");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeRole

Descripción:

Método	Valores devueltos	Descripción
removeRole(String token, String user, String role)	void	Elimina un rol de un usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.removeRole(null, "test", "ROLE_USER");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProfiles

Descripción:

Método	Valores devueltos	Descripción
getProfiles(String token, boolean filterByActive)	List	Devuelve una lista de todos los perfiles.

Nota

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

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.Profile;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            for (Profile profile : okmAuth.getProfiles(null, true)) {
                System.out.println(profile);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserProfile

Descripción:

Método	Valores devueltos	Descripción
getUserProfile(String token, 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 usuario de OpenKM.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            System.out.println(okmAuth.getUserProfile(null, "okmAdmin"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setUserProfile

Descripción:

Método	Valores devueltos	Descripción
setUserProfile(String token, 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 usuario de OpenKM.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.Profile;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            // Set the profile named "default" to the user
            for (Profile profile : okmAuth.getProfiles(null, true)) {
                if (profile.getName().equals("default")) {
                    okmAuth.setUserProfile(null, "okmAdmin", profile.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

logout

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            okmAuth.logout(null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUser

Descripción:

Método	Valores devueltos	Descripción
getUser(String token, String userId)	DbUser	Devuelve los datos del usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.DbUser;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            DbUser commonUser = okmAuth.getUser(null, "okmAdmin");
            System.out.print(commonUser);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setUserPermissions

Descripción:

Método	Valores devueltos	Descripción
public void setUserPermissions(String token, String nodeId, String user, int permissions, boolean recursive)	void	Actualiza los permisos de usuario sobre un nodo.

• El parámetro recursive solo tiene sentido cuando el UUID es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, los cambios se aplicarán al nodo y a sus descendientes.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            // Update permissions of sochoa at the node but not descendants
            okmAuth.setUserPermissions(null, "3c68b3a1-c65c-4b1e-84b5-9ce2712ca573", "sochoa", Permission.READ + Permission.WRITE, false);

            // Update permissions of okmAdmin at the node and descendants
            okmAuth.setUserPermissions(null, "3c68b3a1-c65c-4b1e-84b5-9ce2712ca573", "okmAdmin", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setRolePermissions

Descripción:

Método	Valores devueltos	Descripción
setRolePermissions(String token, String nodeId, String role, int permissions, boolean recursive)	void	Actualiza los permisos de rol sobre un nodo.

• El parámetro recursive solo tiene sentido cuando el UUID es una carpeta o un nodo de registro (record).
• Cuando el parámetro recursive es true, los cambios se aplicarán al nodo y a sus descendientes.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.bean.Permission;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);
            // Update permissions of ROLE_USER at the node but not descendants
            okmAuth.setRolePermissions(null, "3c68b3a1-c65c-4b1e-84b5-9ce2712ca573", "ROLE_USER", Permission.READ + Permission.WRITE, false);

            // Update permissions of ROLE_ADMIN at the node and descendants
            okmAuth.setRolePermissions(null, "3c68b3a1-c65c-4b1e-84b5-9ce2712ca573", "ROLE_ADMIN", Permission.ALL_GRANTS, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserTenants

Descripción:

Método	Valores devueltos	Descripción
getUserTenants(String token)	List	Devuelve una lista de todos los tenants a los que el usuario tiene acceso.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.api.OKMAuth;
import com.openkm.db.bean.Tenant;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            List<Tenant> tenants = okmAuth.getUserTenants(null);
            for (Tenant tenant : tenants) {
                System.out.println(tenant);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setUserTenant

Descripción:

Método	Valores devueltos	Descripción
setUserTenant(String token, long tenantId)	void	Cambia el tenant asignado a un usuario.

Nota

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            long tenantId = 1;
            okmAuth.setUserTenant(null, tenantId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isPasswordExpired

Descripción:

Método	Valores devueltos	Descripción
isPasswordExpired(String token)	Boolean	Comprueba si la contraseña del usuario ha expirado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            Boolean isExpired = okmAuth.isPasswordExpired(null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

resetPassword

Descripción:

Método	Valores devueltos	Descripción
resetPassword(String userId)	void	Envía un correo con un enlace que, si el usuario hace clic en él, restablecerá la contraseña.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMAuth;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMAuth okmAuth = ContextWrapper.getContext().getBean(OKMAuth.class);

            String userId = "okmAdmin";
            okmAuth.resetPassword(userId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}