Webservices (REST API)

Configuration

REST API access is forbidden by default in web server configuration.

You must allow and protect access (for example with htaccess).

You must also enable rest_api in configuration:

$use_restapi = true;

API

Here are available services:

POST /rest/v1/checkpassword.php

Check if a password respect the password policy

Status Codes
  • 200 OK – Successful response

POST /rest/v1/changepassword.php

Allow user to change his own password

Status Codes
  • 200 OK – Successful response

POST /rest/v1/adminchangepassword.php

Allow admin to change the password for a user

Status Codes
  • 200 OK – Successful response