Web service API

How to use PageSeeder's Web service API

administrators

/administrators [POST]

com.pageseeder.member.CreateAdministrator

Description

Administrators

Adds a member to the PageSeeder administrators on this server.

If the member specified (with the email address or username) is non existent, it will be created.

NOTE: Existing members will have their password reset to ensure they have a strong password.

Parameters

Name Description Required Type Default value
auto-activate Whether to activate the new member automatically (member-password should also be set), no boolean false
email The member's email (required if no member-username) conditional string
firstname The member's first name (used if they don't exist) no string "Member"
group Name or id of the group for email template, will override the group on the request no string
member-password The member's password (used if they don't exist) no string [random]
member-username The member's username, defaults to the member's email (required if no email) conditional string
notify-async Whether to send emails asynchronously (for slow email servers) no boolean false
send-email Whether to send a welcome/reset password email to the member no boolean true
surname The member's last name (used if they don't exist) no string [4 digits]

Permission

Undocumented permissions requirements.

Response


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

Error Handling

0x1002 If the email address is invalid.
0x1005 If the maximum number of members on the server has been reached
0x100F If send-email=true and member doesn't have an email address
0x101A The username and email are not from the same member
0x1015 Password is too weak
0x1016 Password cannot be equal to username
0x1025 The member is already an administrator

Created on , last edited on