Call this to initiate a password reset for the given user - together with a case ID.

URL: http[s]://<host>/[<prefix>/]cases/forgotPassword[/1.0]

If you leave out the version, the current version of the service will be called.

• userName optional String
  User to change password for.
  
  
• resetPasswordUrl required String
  Reset password url. Email will be sent with a link
  
  
• claim_case_id optional String
  Optional - pass case_id to allow the case to be claimed
  
  
• case_submitted optional Boolean
  Optional - whether or not the complaint was completed
  
  
• SSO optional String
  Optional SSO token for authentication.
  
  

Allowed HTTP Methods:

• POST

Accept types:

• application/json
• application/xml
• application/x-www-form-urlencoded
• multipart/form

Accept charsets:

• UTF-8
• ISO-8859-1
• LATIN1

Output:

200 OK response type void.

4XX Client Error Response {data:<Error string>} Usually wrong usage by the client.

5XX Server Error Response {data:<Error string>} Exception, error in the service.

Additional comments:

forgotPassword is automatically provided using method reflection.

This service is implemented using the Albicore:SimplifiedService framework.

How to call this service:

• POST JSON in body: { "resetPasswordUrl":<value> }
• POST urlencoded in body: resetPasswordUrl=<value>
• POST multipart/form, encode parameters as parts.

About output:


• 200 OK All valid service executions will return OK response.
• 404 NOT FOUND Resource(s) was not found.
• 4XX error code Errors thrown indicate wrong usage.
• 500 INTERNAL ERROR Exceptions during execution.

The output is default JSON. Output can be controlled by the Accept header, set to one of the below:
• application/json for JSON format, see input description.