public interface People
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_USER |
static String |
PARAM_FIRST_NAME |
static String |
PARAM_ID |
static String |
PARAM_INCLUDE_ASPECTNAMES |
static String |
PARAM_INCLUDE_PROPERTIES |
static String |
PARAM_LAST_NAME |
Modifier and Type | Method and Description |
---|---|
Person |
create(Person person)
Create a person.
|
org.alfresco.service.cmr.repository.NodeRef |
getAvatar(String personId) |
CollectionWithPagingInfo<Person> |
getPeople(Parameters parameters)
Get people list
|
Person |
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 given
userId ). |
void |
resetPassword(String personId,
PasswordReset passwordReset)
Performs password reset
|
Person |
update(String personId,
Person person)
Update the given person's details.
|
String |
validatePerson(String personId) |
String |
validatePerson(String personId,
boolean validateIsCurrentUser) |
static final String DEFAULT_USER
static final String PARAM_INCLUDE_ASPECTNAMES
static final String PARAM_INCLUDE_PROPERTIES
static final String PARAM_FIRST_NAME
static final String PARAM_LAST_NAME
static final String PARAM_ID
org.alfresco.service.cmr.repository.NodeRef getAvatar(String personId)
Person getPerson(String personId)
NoSuchPersonException
- if personId does not existPerson getPerson(String personId, List<String> include)
personId
- include
- Person update(String personId, Person person)
personId
- The identifier of a person.person
- The person details.CollectionWithPagingInfo<Person> getPeople(Parameters parameters)
void requestPasswordReset(String userId, String client)
userId
).
The API returns a 202 response for a valid, as well as the invalid (does not exist or disabled) userIduserId
- the user id of the person requesting the password resetclient
- the client name which is registered to send emailsvoid resetPassword(String personId, PasswordReset passwordReset)
passwordReset
- the password reset detailsCopyright © 2005–2017 Alfresco Software. All rights reserved.