Skip to main content

 Web service API

How to use PageSeeder's Web service API

create membership

/groups/{group}/members/create [POST]

com.pageseeder.membership.CreateMembership

Description

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

Member details

Both the firstname and surname are limited to 20 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 the 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 activate by using the auto-activate boolean parameter.

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, daily 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 member 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

NameDescriptionRequiredTypeDefault value
emailThe new member’s email required if no member-username)maybestring
auto-activateWhether to activate the new member automaticallynobooleanfalse
blank-passwordnostring
field1nostring
field10nostring
field11nostring
field12nostring
field13nostring
field14nostring
field15nostring
field2nostring
field3nostring
field4nostring
field5nostring
field6nostring
field7nostring
field8nostring
field9nostring
firstnameThe new member’s given/other namenostringMember
invitationWhether to create an invitation, otherwise force membershipnoboolean
listedWhether the member’s email address is listed in the groupnobooleanfalse
member-passwordThe new member’s password, is generated if unspecifiednostring
member-usernameThe new member’s username, defaults to the member's emailnostring
notificationThe member’s notification option in the groupnostring
personal-groupWhether to create the personal groupnobooleanfalse
roleThe member’s role in the groupnostring
surnameThe new member’s family namenostring[4 digits]
welcome-emailWhether to send a welcome email to the new membernobooleantrue

Permission

This service requires administrator.

Response

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

Error Handling

Created on , last edited on