OKMAuth
From OpenKM Documentation
Contents |
Methods related to authentication, granting and revoking privileges.
String login(String user, String pas)
Login into the repository and gets a token with user info for future API invocations
Parameters
- user - User nam for login.
- pass - Password for login.
Returns
- A token with authorization session info for next API invocations.
Throws
- UserAlreadyLoggerException - If the user is already logged into the system.
- AccessDeniedException - If authorization fails.
- RepositoryException - If there is an error accessing to repository.
void logout(String token)
Log out from the repository. Invalidates the authorization token.
Parameters
- token - The session authorization token.
Returns
- none
Throws
- AccessDeniedException - If token is not valid.
- RepositoryException – If there is an error accessing to repository.
StringArray getUsers(String token)
Retrieves a list of repository users.
Parameters
- token – The session authorization token.
Returns
- A collection of repository users.
Throws
- RepositoryException – If there is any error retrieving the users list.
StringArray getRoles(String token)
Retrieves a list of repository roles.
Parameters
- token – The session authorization token.
Returns
- A collection of repository roles.
Throws
- RepositoryException – If there is any error retrieving the roles list.