Web service API

How to use PageSeeder's Web service API

members

/members [POST]

com.pageseeder.member.CreateMember

Description

Create a member.

Invoking this service will create a new account for a member in PageSeeder but without joining the member to a group.

Member details

Both the firstname and surname are limited to 20 characters.

The member-username must be less than 100 characters, unique and cannot contain a '@' or ','. 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 address will be used if no confirmation is needed, otherwise, a new password will be generated.

Warning!

Passwords must not be on the banned password list (for example: "passw0rd", "pageseeder")

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.

Note

If you use longer passwords, you don't necessarily need to include digits or special characters!

Other 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 will be set-password (not activated), even if auto-activate is true.

Email templates

This service will use the default PageSeeder templates.

To use customized emails use the customFolder template property.

Parameters

NameDescriptionRequiredTypeDefault value
emailThe new member's email address (required if member-username is not specified).yesemail(empty)
member-usernameThe new member's username (required if email is not specified), defaults to the member's email address.yesstring(empty)
auto-activateWhether to activate the new member automatically (member-password should also be set).nobooleanfalse
firstnameThe new member's first name.no stringMember
member-passwordThe new member's password (will be generated if unspecified).nostring(generated)
personal-groupWhether to create the personal group.nobooleanfalse
surnameThe new member's last name.nostring4 random digits
welcome-emailWhether to send a welcome email to the new member.nobooleantrue
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

The password may be rejected if it isn't strong enough – check against the PageSeeder password policy.

It is mandatory to put values for at least these parameters:

email or member-username

Permission

Only Administrator s can invoke this service.

Member details

Response

<member-creation [welcome-email-failed="true"]>
    <member id="[member id]"
            firstname="[first name]"
            surname="[surname]"
            username="[username]"
            email="[email]"
            status="[activated|unactivated|set-password]">      
        <fullname>[full name]</fullname>
    </member>
</member-creation> 

Error Handling

CodeCause / Description
0x1001If the username contains the character '@' or ",".
0x100AThe email is too long ( more than 100 characters).
0x1002If the email address is invalid.
0x1004If the username or email are already in use.
0x1005If the maximum number of members on the server has been reached.
0x1007The surname or firstname is too long (more than 20 characters).
0x100BIf the Password is too long ( more than 100 characters).
0x1008              At least one of email/username must be specified.
0x1009              The username is too long.( more than 100 characters).
0x1015If the Password is too weak.
0x1016If the Password is equal to the username.

Created on , last edited on