Obsolete Pages{{Obsolete}}
The official documentation is at: http://docs.alfresco.com
Web Services
Back to Alfresco Content Management Web Services.
The administration web service.
Change Log
Data Types
UserDetails
Contains the user property values of a specific user.
- string username - the user name
- NamedValue[] properties - the property values of the user
UserFilter
Used to filter the results when getting users.
- string userName - used as a reg exp style matchin value (eg: Smith* will return all users with a name begining with Smith)
NOTE: additional filters may be added in the future
UserQueryResults
The user query results.
- string querySession - the query session used to batch results from the server
- UserDetails[] userDetails - the user details
NewUserDetails
Contains the information used to create a new user.
- string username - the user name
- string password - the password of the new user
- NamedValue[] properties - the new users property values
Methods
queryUsers
Gets the details of the requested users. If no filter is provided all available users will be retrieved.
UserQueryResults queryUsers(UserFilter filter)
Parameters:
- filter - used to filter the returned users. This parameter is optional. If no value is provided then all available users will be returned.
Returns:
fetchMoreUsers
Fetch the next batch of users from a user query.
UserQueryResults fetchMoreUsers(xsd:string querySession)
Parameters:
- querySession - the query session identifier
Returns:
getUser
Get the details of a user from their user name.
UserDetails getUser(xsd:string userName)
Parameters:
Return:
- the requested user details
createUsers
Create new users with the details provided.
UserDetails[] createUsers(NewUserDetails[] newUsers)
Parameters:
- newUsers - the new users details
Return:
updateUsers
Updates the details of the specified users.
UserDetails[] updateUsers(UserDetails[] users)
Parameters:
- users - the user details that will be updated
Return:
changePassword
Changes the password of the specified user.
void changePassword(xsd:string userName, xsd:string oldPassword, xsd:string newPassword)
Parameters:
- userName - the user name
- oldPassword - the old (current) password
- newPassword - the new password
deleteUsers
Delete the specified users.
void deleteUsers(xsd:string userNames)
Parameters:
- userNames - the names of the users to delete