Difference between revisions of "OKMAuth"
From OpenKM Documentation
(→void revokeRole(String token, String nodePath, String user, int permissions, boolean recursive)) |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | __TOC__ | |
Methods related to authentication, granting and revoking privileges. | Methods related to authentication, granting and revoking privileges. | ||
| − | == String login(String user, String | + | == String login(String user, String pass) == |
| − | Login into the repository and gets | + | Login into the repository and gets an authorization token with user info for future API invocations |
| − | + | '''Parameters''' | |
| − | * user - User nam for login. | + | * ''user'' - User nam for login. |
| − | * pass - Password for login. | + | * ''pass'' - Password for login. |
| − | + | '''Returns''' | |
* A token with authorization session info for next API invocations. | * A token with authorization session info for next API invocations. | ||
| − | + | '''Throws''' | |
| − | * UserAlreadyLoggerException - If the user is already logged into the system. | + | * ''UserAlreadyLoggerException'' - If the user is already logged into the system. |
| − | * AccessDeniedException - If authorization fails. | + | * ''AccessDeniedException'' - If authorization fails. |
| − | * RepositoryException - If there is an error accessing to repository. | + | * ''RepositoryException'' - If there is an error accessing to repository. |
== void logout(String token) == | == void logout(String token) == | ||
Log out from the repository. Invalidates the authorization token. | Log out from the repository. Invalidates the authorization token. | ||
| − | + | '''Parameters''' | |
| − | * token - The session authorization token. | + | * ''token'' - The session authorization token. |
| − | + | '''Returns''' | |
* none | * none | ||
| − | + | '''Throws''' | |
| − | * AccessDeniedException - If token is not valid. | + | * ''AccessDeniedException'' - If token is not valid. |
| − | * RepositoryException | + | * ''RepositoryException'' - If there is an error accessing to repository. |
== StringArray getUsers(String token) == | == StringArray getUsers(String token) == | ||
Retrieves a list of repository users. | Retrieves a list of repository users. | ||
| − | + | '''Parameters''' | |
| − | * token | + | * ''token'' - The session authorization token. |
| − | + | '''Returns''' | |
* A collection of repository users. | * A collection of repository users. | ||
| − | + | '''Throws''' | |
| − | * RepositoryException | + | * ''RepositoryException'' - If there is any error retrieving the users list. |
== StringArray getRoles(String token) == | == StringArray getRoles(String token) == | ||
Retrieves a list of repository roles. | Retrieves a list of repository roles. | ||
| − | + | '''Parameters''' | |
| − | * token | + | * ''token'' - The session authorization token. |
| − | + | '''Returns''' | |
* A collection of repository roles. | * A collection of repository roles. | ||
| − | ==== Throws ==== | + | '''Throws''' |
| − | * RepositoryException | + | * ''RepositoryException'' - If there is any error retrieving the roles list. |
| + | |||
| + | == void grantUser(String token, String nodePath, String user, int permissions, boolean recursive) == | ||
| + | Add user permissions to a node. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | * ''user'' - User name which permissions are changed. | ||
| + | * ''permissions'' - A mask with the permissions to be added. | ||
| + | * ''recursive'' - If the nodePath indicates a folder, the permissions can be applied recursively. | ||
| + | |||
| + | '''Returns''' | ||
| + | * none | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid. | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
| + | |||
| + | == void revokeUser(String token, String nodePath, String user, int permissions, boolean recursive) == | ||
| + | Revoke user permissions from a node. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | * ''user'' - User name which permissions are changed. | ||
| + | * ''permissions'' - A mask with the permissions to be removed. | ||
| + | * ''recursive'' - If the nodePath indicates a folder, the permissions can be revoked recursively. | ||
| + | |||
| + | '''Returns''' | ||
| + | * none | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
| + | |||
| + | == BytePairArray getGrantedUsers(String token, String nodePath) == | ||
| + | Get user permissions from a node (document or folder). | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A hashmap with pairs of user / permissions. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
| + | |||
| + | == void grantRole(String token, String nodePath, String role, int permissions, boolean recursive) == | ||
| + | Grant role permissions for a node. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | * ''role'' - Role name which permissions are changed. | ||
| + | * ''permissions'' - A mask with the permissions to be added. | ||
| + | * ''recursive'' - If the nodePath indicates a folder, the permissions can be applied recursively. | ||
| + | |||
| + | '''Returns''' | ||
| + | * none | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
| + | |||
| + | == void revokeRole(String token, String nodePath, String role, int permissions, boolean recursive) == | ||
| + | Revoke role permissions from a node. | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | * ''role'' - Role name which permissions are changed. | ||
| + | * ''permissions'' - A mask with the permissions to be removed. | ||
| + | * ''recursive'' - If the nodePath indicates a folder, the permissions can be applied recursively. | ||
| + | |||
| + | '''Returns''' | ||
| + | * none | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
| + | |||
| + | == BytePairArray getGrantedRoles(String token, String nodePath) == | ||
| + | Get roles permissions from a node (document or folder). | ||
| + | |||
| + | '''Parameters''' | ||
| + | * ''token'' - The session authorization token. | ||
| + | * ''nodePath'' - The complete path to the node. | ||
| + | |||
| + | '''Returns''' | ||
| + | * A hashmap with pairs of role / permissions. | ||
| + | |||
| + | '''Throws''' | ||
| + | * ''ItemNotFoundException'' - If the node defined by nodePath do not exists. | ||
| + | * ''AccessDeniedException'' - If the token authorization information is not valid | ||
| + | * ''RepositoryException'' - If there is any error accessing to the repository. | ||
[[Category: Webservices Guide]] | [[Category: Webservices Guide]] | ||
Latest revision as of 19:25, 18 April 2012
Contents
- 1 String login(String user, String pass)
- 2 void logout(String token)
- 3 StringArray getUsers(String token)
- 4 StringArray getRoles(String token)
- 5 void grantUser(String token, String nodePath, String user, int permissions, boolean recursive)
- 6 void revokeUser(String token, String nodePath, String user, int permissions, boolean recursive)
- 7 BytePairArray getGrantedUsers(String token, String nodePath)
- 8 void grantRole(String token, String nodePath, String role, int permissions, boolean recursive)
- 9 void revokeRole(String token, String nodePath, String role, int permissions, boolean recursive)
- 10 BytePairArray getGrantedRoles(String token, String nodePath)
Methods related to authentication, granting and revoking privileges.
String login(String user, String pass)
Login into the repository and gets an authorization 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.
void grantUser(String token, String nodePath, String user, int permissions, boolean recursive)
Add user permissions to a node.
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
- user - User name which permissions are changed.
- permissions - A mask with the permissions to be added.
- recursive - If the nodePath indicates a folder, the permissions can be applied recursively.
Returns
- none
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid.
- RepositoryException - If there is any error accessing to the repository.
void revokeUser(String token, String nodePath, String user, int permissions, boolean recursive)
Revoke user permissions from a node.
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
- user - User name which permissions are changed.
- permissions - A mask with the permissions to be removed.
- recursive - If the nodePath indicates a folder, the permissions can be revoked recursively.
Returns
- none
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid
- RepositoryException - If there is any error accessing to the repository.
BytePairArray getGrantedUsers(String token, String nodePath)
Get user permissions from a node (document or folder).
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
Returns
- A hashmap with pairs of user / permissions.
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid
- RepositoryException - If there is any error accessing to the repository.
void grantRole(String token, String nodePath, String role, int permissions, boolean recursive)
Grant role permissions for a node.
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
- role - Role name which permissions are changed.
- permissions - A mask with the permissions to be added.
- recursive - If the nodePath indicates a folder, the permissions can be applied recursively.
Returns
- none
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid
- RepositoryException - If there is any error accessing to the repository.
void revokeRole(String token, String nodePath, String role, int permissions, boolean recursive)
Revoke role permissions from a node.
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
- role - Role name which permissions are changed.
- permissions - A mask with the permissions to be removed.
- recursive - If the nodePath indicates a folder, the permissions can be applied recursively.
Returns
- none
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid
- RepositoryException - If there is any error accessing to the repository.
BytePairArray getGrantedRoles(String token, String nodePath)
Get roles permissions from a node (document or folder).
Parameters
- token - The session authorization token.
- nodePath - The complete path to the node.
Returns
- A hashmap with pairs of role / permissions.
Throws
- ItemNotFoundException - If the node defined by nodePath do not exists.
- AccessDeniedException - If the token authorization information is not valid
- RepositoryException - If there is any error accessing to the repository.
