Interface People

  • All Known Implementing Classes:
    PeopleImpl

    public interface People
    • Method Detail

      • validatePerson

        String validatePerson​(String personId)
      • validatePerson

        String validatePerson​(String personId,
                              boolean validateIsCurrentUser)
      • getPerson

        Person getPerson​(String personId)
        Get a person. This included a full representation of the person.
        Throws:
        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:
      • create

        Person create​(Person person)
        Create a person.
        Parameters:
        person -
        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.
      • requestPasswordReset

        void requestPasswordReset​(String userId,
                                  String client)
        Request password reset (an email will be sent to the registered email of the given userId). 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 reset
        client - 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:
      • deleteAvatarContent

        void deleteAvatarContent​(String personId)
        Parameters:
        personId -