com.adobe.livecycle.rightsmanagement.client
Interface ExternalUserManager

public interface ExternalUserManager

The ExternalUserManager interface provides methods for managing external users.

Method Summary

User[]	inviteExternalUsers(java.util.List emails) Sends email messages to a list of external users to invite them to register with the Rights Management service.
boolean	resetExternalUserPassword(User user, java.lang.String pwd) Resets the password for an external user.

Method Detail

inviteExternalUsers

User[] inviteExternalUsers(java.util.List emails)
                           throws SDKException

Sends email messages to a list of external users to invite them to register with the Rights Management service. The Rights Management service also creates a user account for each email sent. The user account is populated with user information when the registration occurs.

Parameters:

emails - A List object that contains email addresses to which invitations are sent.

Returns:

An array of com.adobe.idp.um.api.infomodel.User objects that were created for each invitation sent.

Throws:

SDKException - if any of the following conditions occur:

• The list of email addresses you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

resetExternalUserPassword

boolean resetExternalUserPassword(User user,
                                  java.lang.String pwd)
                                  throws SDKException

Resets the password for an external user.

Parameters:

user - A com.adobe.idp.um.api.infomodel.User object for which the password is being changed.

pwd - A string value that contains the password value to be used as the new password.

Returns:

A Boolean value that specifies whether the password was reset.

Throws:

SDKException - if any of the following conditions occur:

• The user or password you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.