Auth samples

Basics

The class com.openkm.sdk4csharp.bean.Permission contains permission values (READ, WRITE, etc.). You should use it in combination with methods that change or retrieve security grants.

To set READ and WRITE access you should do:

int permission = Permission.READ + Permission.WRITE;

To check whether you have permission, you should do:

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

In almost all methods, you'll see a parameter named "nodeId". The value of this parameter can be a valid node UUID (folder, document, mail, record) or a node path.

Example of nodeId:

Using UUID -> "c41f9ea0-0d6c-45da-bae4-d72b66f42d0f";

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then you should log in using the "login" method. You can access the "login" method from the webservice object "ws" as shown below:

ws.login(user, password);

Once you are logged in to the webservice, the session is kept in the webservice object. Then you can use the other API methods.

At this point you can use all the Auth methods of the "auth" class, as shown below:

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

Methods

Description:

Method	Return values	Description
login(String personalAccessToken)	String	Returns the authorized login token.
The login token by default has an expiration time of 24 hours. After executing the login method, all subsequent calls will automatically use the authentication token. Each time the login method is executed, the login token is replaced by a new one. When a user logs into the application for the first time, an internal method is called that creates user-specific folders, like /okm:trash/userId, etc. From an API point of view, this method should only be executed the first time a user accesses the API, to create the specific user folder structure. Otherwise you can get errors, for example PathNotExistsException /okm:trash/userId when deleting objects, because the folders have not been created.

Example:

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());
            } 
        }
    }
}

Description:

Method	Return values	Description
login(String user, String password)	String	Returns the authorized login token.
The login token by default has an expiration time of 24 hours. After executing the login method, all subsequent calls will automatically use the authentication token. Each time the login method is executed, the login token is replaced by a new one. When a user logs into the application for the first time, an internal method is called that creates user-specific folders, like /okm:trash/userId, etc. From an API point of view, this method should only be executed the first time a user accesses the API, to create the specific user folder structure. Otherwise you can get errors, for example PathNotExistsException /okm:trash/userId when deleting objects, because the folders have not been created.

Method

Return values

Description

login(String user, String password)

String

Returns the authorized login token.

The login token by default has an expiration time of 24 hours.

After executing the login method, all subsequent calls will automatically use the authentication token.

Each time the login method is executed, the login token is replaced by a new one.

When a user logs into the application for the first time, an internal method is called that creates user-specific folders, like /okm:trash/userId, etc.

From an API point of view, this method should only be executed the first time a user accesses the API, to create the specific user folder structure.

Otherwise you can get errors, for example PathNotExistsException /okm:trash/userId when deleting objects, because the folders have not been created.

Example:

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());
            } 
        }
    }
}

Description:

Method	Return values	Description
String login(String user, String password, int expiration, bool restrictIp)	String	Login process return authentication token.
The login token by default has a variable expiration time defined in days. When restrictIP is true, the token will only work from the source IP address. After executing the login method, all subsequent calls will automatically use the authentication token. Each time the login method is executed, the login token is replaced by a new one. When a user logs into the application for the first time, an internal method is called that creates user-specific folders, like /okm:trash/userId, etc. From an API point of view, this method should only be executed the first time a user accesses the API, to create the specific user folder structure. Otherwise you can get errors, for example PathNotExistsException /okm:trash/userId when deleting objects, because the folders have not been created.

Example:

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

Description:

Method	Return values	Description
logout()	void	Executes the logout method on the OpenKM side.
The authentication token will be reset.

Example:

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

Description:

Method	Return values	Description
getRefreshToken()	String	Refreshes the current authentication token.
When logged in, an authentication token is set in the OKMWebservice. By default, the authentication token expires in 24 hours. This method allows the replacement of the current token with a new one.

Example:

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

Description:

Method	Return values	Description
getGrantedRoles(String nodeId)	Dictionary<String, int>	Returns the granted roles of a node.

Example:

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

Description:

Method	Return values	Description
getGrantedUsers(String nodeId)	Dictionary<String, int>	Returns the granted users of a node.

Example:

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

Description:

Method	Return values	Description
getRoles(boolean showAll)	List<String>	Returns the list of all the roles.
When the showAll variable is set to true, it returns all the roles - enabled and disabled - otherwise it only returns the enabled ones.

Example:

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

Description:

Method	Return values	Description
getRolesByUser(String user)	List<String>	Returns the list of all the roles assigned to a user.

Example:

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

Description:

Method	Return values	Description
getUser(String userId)	CommonUser	Returns a user.

Example:

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

Description:

Method	Return values	Description
getUsers(boolean showAll)	List<CommonUser>	Returns the list of all the users.
When the showAll variable is set to true, it returns all the users - enabled and disabled - otherwise it only returns the enabled ones.

Example:

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

Description:

Method	Return values	Description
getUsersByRole(String roleId)	List<CommonUser>	Returns the list of all users who have been assigned a role.

Example:

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

Description:

Method	Return values	Description
revokeRole(String nodeId, String role, int permissions, boolean recursive)	void	Removes a role grant from a node.
The parameter recursive only makes sense when the nodeId is a folder or record node. When the parameter recursive is true, the change will be applied to the node and descendants.

Method

Return values

Description

revokeRole(String nodeId, String role, int permissions, boolean recursive)

void

Removes a role grant from a node.

The parameter recursive only makes sense when the nodeId is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and descendants.

Example:

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

Description:

Method	Return values	Description
revokeUser(String nodeId, String user, int permissions, boolean recursive)	void	Removes a user grant from a node.
The parameter recursive only makes sense when the nodeId is a folder or record node. When the parameter recursive is true, the change will be applied to the node and descendants.

Method

Return values

Description

revokeUser(String nodeId, String user, int permissions, boolean recursive)

void

Removes a user grant from a node.

The parameter recursive only makes sense when the nodeId is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and descendants.

Example:

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

Description:

Method	Return values	Description
grantRole(String nodeId, String role, int permissions, boolean recursive)	void	Adds a role grant to a node.
The parameter recursive only makes sense when the nodeId is a folder or record node. When the parameter recursive is true, the change will be applied to the node and descendants.

Method

Return values

Description

grantRole(String nodeId, String role, int permissions, boolean recursive)

void

Adds a role grant to a node.

The parameter recursive only makes sense when the nodeId is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and descendants.

Example:

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

Description:

Method	Return values	Description
grantUser(String nodeId, String userId, int permissions, boolean recursive)	void	Adds a user grant to a node.
The parameter recursive only makes sense when the nodeId is a folder or record node. When the parameter recursive is true, the change will be applied to the node and descendants.

Method

Return values

Description

grantUser(String nodeId, String userId, int permissions, boolean recursive)

void

Adds a user grant to a node.

The parameter recursive only makes sense when the nodeId is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and descendants.

Example:

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

Description:

Method	Return values	Description
getProfiles(boolean filterByActive)	List<Profile>	Returns the list of all profiles.
When the parameter filterByActive is enabled, the method returns only the active profiles; otherwise it returns all available profiles. Each user is assigned one profile that enables more or fewer OpenKM UI features.

Method

Return values

Description

getProfiles(boolean filterByActive)

List<Profile>

Returns the list of all profiles.

When the parameter filterByActive is enabled, the method returns only the active profiles; otherwise it returns all available profiles.

Each user is assigned one profile that enables more or fewer OpenKM UI features.

Example:

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

Description:

Method	Return values	Description
getUserProfile(String userId)	Profile	Returns the profile assigned to a user.
Each user has assigned one profile that enables more or less OpenKM UI features.

Example:

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

Description:

Method	Return values	Description
setUserProfile(String userId, long profileId)	void	Changes the profile assigned to a user.
Each user has assigned one profile that enables more or less OpenKM UI features.

Example:

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

Description:

Method	Return values	Description
createUser(String user, String password, String email, String name, Boolean active)	void	Creates a new user.

Example:

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

Description:

Method	Return values	Description
deleteUser(String userId)	void	Deletes a user.

Example:

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

Description:

Method	Return values	Description
updateUser(String userId, String password, String email, String name, Boolean active)	void	Updates a user.

Example:

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

Description:

Method	Return values	Description
createRole(String roleId, boolean active)	void	Creates a new role.

Example:

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

Description:

Method	Return values	Description
deleteRole(String roleId)	void	Deletes a role.

Example:

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

Description:

Method	Return values	Description
updateRole(String roleId, boolean active)	void	Updates a role.

Example:

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

Description:

Method	Return values	Description
assignRole(String userId, String roleId)	void	Assigns a role to a user.

Example:

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

Description:

Method	Return values	Description
removeRole(String userId, String roleId)	void	Removes a role from a user.

Example:

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

Description:

Method	Return values	Description
changeSecurity(ChangeSecurity changeSecurity)	void	Changes the security of a node.

Example:

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

Description:

Method	Return values	Description
overwriteSecurity(String uuid, ChangeSecurity changeSecurity)	void	Overwrites the security of a node.
The ChangeSecurity object is used in the changeSecurity and overwriteSecurity methods. Although values set in the revokeUsers and revokeRoles variables of the ChangeSecurity object are present, these values will not be taken into consideration when overwriting the security.

Example:

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

Description:

Method	Return values	Description
getGrantedUsersAndRoles(String uuid)	GrantedUsersAndRolesItem	Returns the granted users and roles of a node.

Example:

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

Description:

Method	Return values	Description
setUserPermissions(String uuid, String userId, int permissions, bool recursive)	void	Updates user permissions on a node.
The parameter recursive only makes sense when the uuid is a folder or record node. When the parameter recursive is true, the change will be applied to the node and its descendants.

Method

Return values

Description

setUserPermissions(String uuid, String userId, int permissions, bool recursive)

void

Updates user permissions on a node.

The parameter recursive only makes sense when the uuid is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and its descendants.

Example:

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

Description:

Method	Return values	Description
setRolePermissions(String uuid, String roleId, int permissions, bool recursive)	void	Updates role permissions on a node.
The parameter recursive only makes sense when the uuid is a folder or record node. When the parameter recursive is true, the change will be applied to the node and its descendants.

Method

Return values

Description

setRolePermissions(String uuid, String roleId, int permissions, bool recursive)

void

Updates role permissions on a node.

The parameter recursive only makes sense when the uuid is a folder or record node.

When the parameter recursive is true, the change will be applied to the node and its descendants.

Example:

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

Description:

Method	Return values	Description
getUserTenants()	List<Tenant>	Returns the list of all tenants.

Example:

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

Description:

Method	Return values	Description
setUserTenant(long tenantId)	void	Change the assigned tenant for a user.
A user might have access to several tenants but have only one assigned.

Example:

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

Description:

Method	Return values	Description
isAdmin()	bool	Check if the authenticated user is a member of the administrators.

Example:

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

Description:

Method	Return values	Description
getSessionId()	String	Get the HTTP session ID.

Example:

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

Description:

Method	Return values	Description
hasSecurityRecursive()	bool	Check if the user has permission to propagate security recursively.
The role is set in the configuration parameter named "default.security.recursive.role."

Method

Return values

Description

hasSecurityRecursive()

bool

Check if the user has permission to propagate security recursively.

The role is set in the configuration parameter named "default.security.recursive.role."

Example:

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

Description:

Method	Return values	Description
hasTaskManagerAdmin()	bool	Check if the user is a member of the "task manager admin" role.
The configuration parameter named "default.task.manager.admin.role" is used to indicate the role.

Example:

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

Description:

Method	Return values	Description
isLoginLowercase()	bool	Return true when the user's login must be in lowercase.

Example:

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

Description:

Method	Return values	Description
isPasswordExpired()	Boolean	True when the user's password has expired.
By default, password expiration is disabled. Take a look at the configuration parameter named "user.password.expiration" in the Security configuration parameters section to enable.

Example:

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

Description:

Method	Return values	Description
getUserToken(String userId)	String	Return the auth token for a given user.
This action can only be done by a superuser (a user with ROLE_ADMIN).

Example:

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

Description:

Method	Return values	Description
getUserToken(String userId, int expiration, bool restrictIp)	String	Return the auth token for a given user.
This action can only be done by a superuser (a user with ROLE_ADMIN).

Example:

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

Description:

Method	Return values	Description
createPersonalAccessToken(String name, DateTime expiration)	String	Return the personal access token.
You can generate a personal access token for each application that requires access to the API.

Example:

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());
             } 
        }
    }
}

Table of contents [ Hide Show ]

Basics
Methods

login
login
login
logout
getRefreshToken
getGrantedRoles
getGrantedUsers
getRoles
getRolesByUser
getUser
getUsers
getUsersByRole
revokeRole
revokeUser
grantRole
grantUser
getProfiles
getUserProfile
setUserProfile
createUser
deleteUser
updateUser
createRole
deleteRole
updateRole
assignRole
removeRole
changeSecurity
overwriteSecurity
getGrantedUsersAndRoles
setUserPermissions
setRolePermissions
getUserTenants
setUserTenant
isAdmin
getSessionId
hasSecurityRecursive
hasTaskManagerAdmin
isLoginLowercase
isPasswordExpired
getUserToken
getUserToken
createPersonalAccessToken

SDK for .NET 5.7.0

Auth samples

Basics

Suggested code sample

Methods

login

login

login

logout

getRefreshToken

getGrantedRoles

getGrantedUsers

getRoles

getRolesByUser

getUser

getUsers

getUsersByRole

revokeRole

revokeUser

grantRole

grantUser

getProfiles

getUserProfile

setUserProfile

createUser

deleteUser

updateUser

createRole

deleteRole

updateRole

assignRole

removeRole

changeSecurity

overwriteSecurity

getGrantedUsersAndRoles

setUserPermissions

setRolePermissions

getUserTenants

setUserTenant

isAdmin

getSessionId

hasSecurityRecursive

hasTaskManagerAdmin

isLoginLowercase

isPasswordExpired

getUserToken

getUserToken

createPersonalAccessToken