memberships

Description

Create a member and add the member to a group.

Creates a new member in PageSeeder and invites the member to a group.

This service can also be used to register the new Member to a Group.

Member details

Both the firstname and surname are limited to 50 characters. If the first name is not specified, it defaults to Member.

The member-username must be less than 100 characters, unique and cannot contain a ‘@’. The username is required unless an email address is specified.

The email must be less than 100 characters, unique and be a valid Email address. The email address is required unless a username is specified.

Password details

The member-password must be less than 100 characters. When the Password is not specified, the member’s email is used if no confirmation is needed, otherwise, a new password is generated.

Passwords must satisfy a given strength check to be accepted:

• Regular members must have at least a MEDIUM strength
• Administrators must use a STRONG password

Other member options

It is possible to create a personal group using the personal-group boolean parameter.

To send a welcome email to the new member, use the welcome-email boolean parameter.

The account can be automatically activated by using the auto-activate boolean parameter. If the member-password is not set, then the member’s status is set-password (not activated) even if auto-activate is true.

Group membership parameters

If a group is specified on the request, the new member is also added to the group. All group membership parameters are optional and default to the group’s default values.

The notification parameter must be one of immediate, essential, daily, weekly or none. Users are able to subsequently change this setting through the user interface in their group registration options.

The role parameter must be one of guest, reviewer, contributor, manager, approver, moderator-and-approver, moderator.

The listed boolean parameter can be used to override the group’s default setting. It affects whether other group members are able to see the member’s user details. Users are able to subsequently change this setting through the user interface in their group registration options.

The invitation parameter can be used to force the group invitation email to be sent to the new member or to prevent that email to be sent. The default behavior follows the value of the project property acceptInvitationRequired.

Additional information specific to the group can also be attached to the user using the details fields field1 to field15.

Parameters

Permission

This service requires administrator.

Response

If successful, this service returns the membership that was created as a <membership> element wrapped in <membership-creation> element.

The @welcome-email-failed attribute is only included if PageSeeder was unable to send the welcome email.

<membership-creation [welcome-email-failed="true"]>
  <membership id="[membershipid]" 
              email-listed="[true|false]" 
              notification="[none|essential|immediate|daily|weekly]"
              flags="[flags]"
              status="[invited|normal]"
              role="[role]">
    <member id="[member id]"
            firstname="[first name]"
            surname="[surname]"
            username="[username]"
            email="[email]"
            status="[activated|unactivated|set-password]">
      <fullname>[full name]</fullname>
    </member>
    <group id="[group id]"
           name="[name]"
           flags="[flags]"
           visibility="[visibility]"
           template="[template]">
      <description>[description]</description>
    </group>
  </membership>
</membership-creation>

Error Handling