Web service API

How to use PageSeeder's Web service API

unlock member

/members/{member}/unlock [POST]

com.pageseeder.member.UnlockMember

Description

Unlock a member's account.

This service allows an Administrator to unlock the account of a member.

Accounts are automatically locked after a number of failed attempts at login. After an account is locked, members will not be able to access their account even if they supply the correct username and password: only administrators can unlock their account.

Account locking can be configured in the Global Properties.

If the account of the Member is not locked, this service has not effect and will return a successful response.

Note

When member successfully reset their password, their account is automatically unlocked. So user's can unlock their own by going via the reset password flow.

Parameters

No parameters required - the Member to unlock is specified in the URL.

Permission

This service can only be invoked by an administrator.

Response

This service returns a single <member> element wrapped in a <member-account> element. The @locked attribute (of absence thereof) on the <member> element can be used to check whether the member account has been unlocked.

<member-account locked="false">
   <member>
     <!-- Member XML -->
   </member>
</member-account>

From PageSeeder 5.93, this service will use <member-unlock> as a wrapper instead:

<member-unlock> 
   <member> 
      <!-- Member XML -->
   </member>
</member-unlock>

Error Handling

CodeCause / Description
0x0204The member not found.
0x0101Access forbidden.

Created on , last edited on