Package org.alfresco.rest.api
Interface People
- All Known Implementing Classes:
PeopleImpl
public interface People
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionCreate a person.void
deleteAvatarContent
(String personId) downloadAvatarContent
(String personId, Parameters parameters) getPeople
(Parameters parameters) Get people listGet a person.Get a person, specifying optional includes as required.void
requestPasswordReset
(String userId, String client) Deprecated.void
resetPassword
(String personId, PasswordReset passwordReset) Deprecated.from 7.1.0 Performs password resetUpdate the given person's details.uploadAvatarContent
(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters) validatePerson
(String personId) validatePerson
(String personId, boolean validateIsCurrentUser)
-
Field Details
-
DEFAULT_USER
- See Also:
-
PARAM_INCLUDE_ASPECTNAMES
- See Also:
-
PARAM_INCLUDE_PROPERTIES
- See Also:
-
PARAM_INCLUDE_CAPABILITIES
- See Also:
-
PARAM_FIRST_NAME
- See Also:
-
PARAM_LAST_NAME
- See Also:
-
PARAM_ID
- See Also:
-
-
Method Details
-
validatePerson
-
validatePerson
-
getAvatar
-
getPerson
Get a person. This included a full representation of the person.- Throws:
NoSuchPersonException
- if personId does not exist
-
getPerson
Get a person, specifying optional includes as required.- Parameters:
personId
-include
-- Returns:
-
create
Create a person.- Parameters:
person
-- Returns:
-
update
Update the given person's details.- Parameters:
personId
- The identifier of a person.person
- The person details.- Returns:
- The updated person details.
-
getPeople
Get people list- Returns:
- CollectionWithPagingInfo
-
requestPasswordReset
Deprecated.from 7.1.0 Request password reset (an email will be sent to the registered email of the givenuserId
). The API returns a 202 response for a valid, as well as the invalid (does not exist or disabled) userId- Parameters:
userId
- the user id of the person requesting the password resetclient
- the client name which is registered to send emails
-
resetPassword
Deprecated.from 7.1.0 Performs password reset- Parameters:
passwordReset
- the password reset details
-
downloadAvatarContent
- Parameters:
personId
-parameters
-- Returns:
-
uploadAvatarContent
Person uploadAvatarContent(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters) - Parameters:
personId
-contentInfo
-stream
-parameters
-- Returns:
-
deleteAvatarContent
- Parameters:
personId
-
-
userId
).