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 creates 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 '@'. 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 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 not 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 activate 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 (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 emailyesstring(empty)
auto-activateWhether to activate the new member automatically (member-password should also be set)nobooleanfalse
firstnameThe new member's first nameno stringMember
member-passwordThe new member's password, will be generated if unspecifiednostring(generated)
personal-groupWhether to create the personal groupnobooleanfalse
surnameThe new member's last namenostring4 random digits
welcome-emailWhether to send a welcome email to the new membernobooleantrue

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

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
0x1001 If the username contains the character '@'
0x1002 If the email address is invalid
0x1004 If the username or email are already in use
0x1005 If the maximum number of members on the server has been reached
0x100B If the Password is too long
0x1015 If the Password is too weak
0x1016 If the Password is equal to the username

Created on , last edited on