Difference between revisions of "OKMAuth"
From OpenKM Documentation
| Line 7: | Line 7: | ||
'''Parameters''' | '''Parameters''' | ||
| − | * user - User nam for login. | + | * ''user'' - User nam for login. |
| − | * pass - Password for login. | + | * ''pass'' - Password for login. |
'''Returns''' | '''Returns''' | ||
| Line 14: | Line 14: | ||
'''Throws''' | '''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) == | ||
| Line 22: | Line 22: | ||
'''Parameters''' | '''Parameters''' | ||
| − | * token - The session authorization token. | + | * ''token'' - The session authorization token. |
'''Returns''' | '''Returns''' | ||
| Line 28: | Line 28: | ||
'''Throws''' | '''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) == | ||
| Line 35: | Line 35: | ||
'''Parameters''' | '''Parameters''' | ||
| − | * token | + | * ''token'' - The session authorization token. |
'''Returns''' | '''Returns''' | ||
| Line 41: | Line 41: | ||
'''Throws''' | '''Throws''' | ||
| − | * RepositoryException | + | * ''RepositoryException'' - If there is any error retrieving the users list. |
== StringArray getRoles(String token) == | == StringArray getRoles(String token) == | ||
| Line 47: | Line 47: | ||
'''Parameters''' | '''Parameters''' | ||
| − | * token | + | * ''token'' - The session authorization token. |
'''Returns''' | '''Returns''' | ||
| Line 53: | Line 53: | ||
'''Throws''' | '''Throws''' | ||
| − | * RepositoryException | + | * ''RepositoryException'' - If there is any error retrieving the roles list. |
[[Category: Webservices Guide]] | [[Category: Webservices Guide]] | ||
Revision as of 10:43, 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.
