Package org.alfresco.rest.api
Interface People
-
- All Known Implementing Classes:
PeopleImpl
public interface People
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_USER
static String
PARAM_FIRST_NAME
static String
PARAM_ID
static String
PARAM_INCLUDE_ASPECTNAMES
static String
PARAM_INCLUDE_CAPABILITIES
static String
PARAM_INCLUDE_PROPERTIES
static String
PARAM_LAST_NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Person
create(Person person)
Create a person.void
deleteAvatarContent(String personId)
BinaryResource
downloadAvatarContent(String personId, Parameters parameters)
org.alfresco.service.cmr.repository.NodeRef
getAvatar(String personId)
CollectionWithPagingInfo<Person>
getPeople(Parameters parameters)
Get people listPerson
getPerson(String personId)
Get a person.Person
getPerson(String personId, List<String> include)
Get a person, specifying optional includes as required.void
requestPasswordReset(String userId, String client)
Request password reset (an email will be sent to the registered email of the givenuserId
).void
resetPassword(String personId, PasswordReset passwordReset)
Performs password resetPerson
update(String personId, Person person)
Update the given person's details.Person
uploadAvatarContent(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)
String
validatePerson(String personId)
String
validatePerson(String personId, boolean validateIsCurrentUser)
-
-
-
Field Detail
-
DEFAULT_USER
static final String DEFAULT_USER
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_ASPECTNAMES
static final String PARAM_INCLUDE_ASPECTNAMES
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_PROPERTIES
static final String PARAM_INCLUDE_PROPERTIES
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_CAPABILITIES
static final String PARAM_INCLUDE_CAPABILITIES
- See Also:
- Constant Field Values
-
PARAM_FIRST_NAME
static final String PARAM_FIRST_NAME
- See Also:
- Constant Field Values
-
PARAM_LAST_NAME
static final String PARAM_LAST_NAME
- See Also:
- Constant Field Values
-
PARAM_ID
static final String PARAM_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAvatar
org.alfresco.service.cmr.repository.NodeRef getAvatar(String personId)
-
getPerson
Person getPerson(String personId)
Get a person. This included a full representation of the person.- Throws:
org.alfresco.service.cmr.security.NoSuchPersonException
- if personId does not exist
-
getPerson
Person getPerson(String personId, List<String> include)
Get a person, specifying optional includes as required.- Parameters:
personId
-include
-- Returns:
-
update
Person update(String personId, Person person)
Update the given person's details.- Parameters:
personId
- The identifier of a person.person
- The person details.- Returns:
- The updated person details.
-
getPeople
CollectionWithPagingInfo<Person> getPeople(Parameters parameters)
Get people list- Returns:
- CollectionWithPagingInfo
-
requestPasswordReset
void requestPasswordReset(String userId, String client)
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
void resetPassword(String personId, PasswordReset passwordReset)
Performs password reset- Parameters:
passwordReset
- the password reset details
-
downloadAvatarContent
BinaryResource downloadAvatarContent(String personId, Parameters parameters)
- Parameters:
personId
-parameters
-- Returns:
-
uploadAvatarContent
Person uploadAvatarContent(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)
- Parameters:
personId
-contentInfo
-stream
-parameters
-- Returns:
-
deleteAvatarContent
void deleteAvatarContent(String personId)
- Parameters:
personId
-
-
-