Difference between revisions of "OKMAuth"
From OpenKM Documentation
| Line 54: | Line 54: | ||
'''Throws''' | '''Throws''' | ||
* ''RepositoryException'' - If there is any error retrieving the roles list. | * ''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. | ||
[[Category: Webservices Guide]] | [[Category: Webservices Guide]] | ||
Revision as of 10:48, 8 March 2010
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.
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.
