mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
cded2f354d
135590 jkaabimofrad: APPSREPO-35: Added password reset V1 API. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@135930 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
106 lines
3.4 KiB
Java
106 lines
3.4 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* Copyright (C) 2005 - 2017 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.rest.api;
|
|
|
|
import org.alfresco.rest.api.model.PasswordReset;
|
|
import org.alfresco.rest.api.model.Person;
|
|
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.security.NoSuchPersonException;
|
|
|
|
import java.util.List;
|
|
|
|
public interface People
|
|
{
|
|
String DEFAULT_USER = "-me-";
|
|
String PARAM_INCLUDE_ASPECTNAMES = "aspectNames";
|
|
String PARAM_INCLUDE_PROPERTIES = "properties";
|
|
String PARAM_FIRST_NAME = "firstName";
|
|
String PARAM_LAST_NAME = "lastName";
|
|
String PARAM_ID = "id";
|
|
|
|
String validatePerson(String personId);
|
|
String validatePerson(String personId, boolean validateIsCurrentUser);
|
|
NodeRef getAvatar(String personId);
|
|
|
|
/**
|
|
* Get a person. This included a full representation of the person.
|
|
*
|
|
* @throws NoSuchPersonException if personId does not exist
|
|
*/
|
|
Person getPerson(final String personId);
|
|
|
|
/**
|
|
* Get a person, specifying optional includes as required.
|
|
*
|
|
* @param personId
|
|
* @param include
|
|
* @return
|
|
*/
|
|
Person getPerson(String personId, List<String> include);
|
|
|
|
/**
|
|
* Create a person.
|
|
*
|
|
* @param person
|
|
* @return
|
|
*/
|
|
Person create(Person person);
|
|
|
|
/**
|
|
* Update the given person's details.
|
|
*
|
|
* @param personId The identifier of a person.
|
|
* @param person The person details.
|
|
* @return The updated person details.
|
|
*/
|
|
Person update(String personId, Person person);
|
|
|
|
/**
|
|
* Get people list
|
|
*
|
|
* @return CollectionWithPagingInfo<Person>
|
|
*/
|
|
CollectionWithPagingInfo<Person> getPeople(Parameters parameters);
|
|
|
|
/**
|
|
* Request password reset (an email will be sent to the registered email of the given {@code userId}).
|
|
* The API returns a 202 response for a valid, as well as the invalid (does not exist or disabled) userId
|
|
*
|
|
* @param userId the user id of the person requesting the password reset
|
|
* @param client the client name which is registered to send emails
|
|
*/
|
|
void requestPasswordReset(String userId, String client);
|
|
|
|
/**
|
|
* Performs password reset
|
|
*
|
|
* @param passwordReset the password reset details
|
|
*/
|
|
void resetPassword(String personId, PasswordReset passwordReset);
|
|
}
|