Contents
On this page

Get Role Migration - Plugixa Advanced User Role Editor

GET /plugixa-aure/v1/users/migrate

The state of the background move between roles started with Start Role Migration. Only one move exists at a time; this is the latest.

Needs the Edit people permission: plugixa_aure_edit_users. Part of the Users feature: when it is switched off in Settings the route is not registered and answers 404.

Request

GET https://your-site.example/wp-json/plugixa-aure/v1/users/migrate

Responses

200 OK. data is the move.

{
  "success": true,
  "data": {
    "state": "running",
    "from": "subscriber",
    "to": "customer",
    "mode": "replace",
    "total": 1250,
    "processed": 200,
    "changed": 200,
    "actor": 1,
    "started": "2026-11-12 09:30:00",
    "finished": "",
    "message": ""
  }
}
Field Type Meaning
data.state string idle (never run), running, done or cancelled
data.from, data.to string Source and target role slugs
data.mode string add, replace or remove
data.total integer Accounts to process, counted at the start
data.processed integer Accounts looked at so far
data.changed integer Accounts actually changed so far
data.actor integer Id of the user who started it
data.started, data.finished string UTC datetimes. Empty until set
data.message string A sentence for people, set when the move finishes or is cancelled

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-aure/v1/users/migrate" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-aure/v1/users/migrate');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-aure/v1/users/migrate', {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();

Quick Links

Share