Admin reference

Basics

This document describes Pryv.io’s administration API, allowing to configure the platform parameters and manage platform users. This service is only available with an Entreprise license.

Administration service

The administration service has its own API and authentication mechanism.

Authorization

All requests for retrieving and manipulating admin data must carry a valid JSON web token that is obtained at login.

It must be assigned to the authorization header.

API methods

The methods are called via HTTPS on the administration server: https://lead.{domain}.

Authentication

Methods for authenticating admin users.

idauth.loginHTTP-onlyPOST {admin}/auth/login

Authenticates the user against the provided credentials.

Parameters

`username`	string The user’s username
`password`	string The user’s password

Result

HTTP200 OK

`token`	string JSON web token to use for further API calls.

Authenticating admin user

{
  "password": "my-secret-password"
}

⬇

{
  "token": "eyJ1c2VybmFtZSI6ImlsaWEiLCJwZXJtaXNzaW9ucyI6eyJ1c2VycyI6WyJyZWFkIiwiY3JlYXRlIiwiZGVsZXRlIiwicmVzZXRQYXNzd29yZCIsImNoYW5nZVBlcm1pc3Npb25zIl0sInNldHRpbmdzIjpbInJlYWQiLCJ1cGRhdGUiXX0sImlhdCI6MTU5OTIyNDM4MywiZXhwIjoxNTk5MzEwNzgzfQ"
}

curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"quaid","password":"my-secret-password"}' "https://lead.pryv.me/auth/login"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "token": "eyJ1c2VybmFtZSI6ImlsaWEiLCJwZXJtaXNzaW9ucyI6eyJ1c2VycyI6WyJyZWFkIiwiY3JlYXRlIiwiZGVsZXRlIiwicmVzZXRQYXNzd29yZCIsImNoYW5nZVBlcm1pc3Npb25zIl0sInNldHRpbmdzIjpbInJlYWQiLCJ1cGRhdGUiXX0sImlhdCI6MTU5OTIyNDM4MywiZXhwIjoxNTk5MzEwNzgzfQ"
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"quaid","password":"my-secret-password"}' "https://lead.pryv.me/auth/login"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "token": "eyJ1c2VybmFtZSI6ImlsaWEiLCJwZXJtaXNzaW9ucyI6eyJ1c2VycyI6WyJyZWFkIiwiY3JlYXRlIiwiZGVsZXRlIiwicmVzZXRQYXNzd29yZCIsImNoYW5nZVBlcm1pc3Npb25zIl0sInNldHRpbmdzIjpbInJlYWQiLCJ1cGRhdGUiXX0sImlhdCI6MTU5OTIyNDM4MywiZXhwIjoxNTk5MzEwNzgzfQ"
}

Logout user

idauth.logoutHTTP-onlyPOST {admin}/auth/logout

Terminates a session by invalidating its JSON web token (the user will have to login again). Simply provide the JSON web token in own of the the supported ways, no request body is required.

Result

HTTP200 OK

{}

⬇

{}

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/auth/logout"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/auth/logout"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{}

Admin users

Methods for managing admin users.

Retrieve admin users information

idadminUsers.getHTTP-onlyGET {admin}/users

Retrieves the admin users information.

Parameters

Result

HTTP200 OK

`users`	Array of admin users The admin users information.

Fetching admin users.

{}

⬇

{
  "users": [
    {
      "username": "admin",
      "permissions": {
        "users": [
          "read",
          "create",
          "delete",
          "resetPassword",
          "changePermissions"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    },
    {
      "username": "harrytasker",
      "permissions": {
        "users": [
          "read"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    }
  ]
}

curl -i "https://lead.pryv.me/users"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "users": [
    {
      "username": "admin",
      "permissions": {
        "users": [
          "read",
          "create",
          "delete",
          "resetPassword",
          "changePermissions"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    },
    {
      "username": "harrytasker",
      "permissions": {
        "users": [
          "read"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    }
  ]
}

Only available for HTTP REST

Only available for HTTP REST

curl -i "https://lead.pryv.me/users"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "users": [
    {
      "username": "admin",
      "permissions": {
        "users": [
          "read",
          "create",
          "delete",
          "resetPassword",
          "changePermissions"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    },
    {
      "username": "harrytasker",
      "permissions": {
        "users": [
          "read"
        ],
        "settings": [
          "read",
          "update"
        ],
        "platformUsers": [
          "read",
          "delete"
        ]
      }
    }
  ]
}

Retrieve admin user information

idadminUsers.getOneHTTP-onlyGET {admin}/users/{username}

Retrieves the admin user’s information.

Parameters

`username`	stringHTTPset in request path The username of the admin user.

Result

HTTP200 OK

`user`	admin user The admin user’s information.

Fetching one admin user’s information.

{}

⬇

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

curl -i "https://lead.pryv.me/users/harrytasker"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i "https://lead.pryv.me/users/harrytasker"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Create an admin user

idadminUsers.createHTTP-onlyPOST {admin}/users

Creates an admin user.

Parameters

`username`	string The username of the admin user.
`password`	string The password of the admin user.
`permissions`	string The permissions of the admin user.

Result

HTTP200 OK

`user`	admin user The created admin user’s information.

Creating an admin user.

{
  "permissions": {
    "users": [
      "read"
    ],
    "settings": [
      "read",
      "update"
    ],
    "platformUsers": [
      "read",
      "delete"
    ]
  }
}

⬇

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"harrytasker","permissions":{"users":["read"],"settings":["read","update"],"platformUsers":["read","delete"]}}' "https://lead.pryv.me/users"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{"username":"harrytasker","permissions":{"users":["read"],"settings":["read","update"],"platformUsers":["read","delete"]}}' "https://lead.pryv.me/users"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Update an admin user's permissions

idadminUsers.updatePermissionsHTTP-onlyPUT {admin}/users/{username}/permissions

Updates an admin user’s permissions.

Parameters

`permissions`	admin permissions The permissions of the admin user.

Result

HTTP200 OK

`user`	admin user The updated admin user’s information.

Updating an admin user’s permissions.

{
  "permissions": {
    "users": [
      "read"
    ],
    "settings": [
      "read",
      "update"
    ],
    "platformUsers": [
      "read",
      "delete"
    ]
  }
}

⬇

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

curl -i -X PUT -H 'Content-Type: application/json' -d '{"permissions":{"users":["read"],"settings":["read","update"],"platformUsers":["read","delete"]}}' "https://lead.pryv.me/users/${username}/permissions"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X PUT -H 'Content-Type: application/json' -d '{"permissions":{"users":["read"],"settings":["read","update"],"platformUsers":["read","delete"]}}' "https://lead.pryv.me/users/${username}/permissions"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "harrytasker",
    "permissions": {
      "users": [
        "read"
      ],
      "settings": [
        "read",
        "update"
      ],
      "platformUsers": [
        "read",
        "delete"
      ]
    }
  }
}

Reset an admin user's password

idadminUsers.resetPasswordHTTP-onlyPOST {admin}/users/{username}/reset-password

Resets an admin user’s password.

Parameters

`username`	stringHTTPset in request path The username of the admin user for whom to reset the password.

Result

HTTP200 OK

`password`	string The admin user’s new password.

Resetting an admin user’s password.

{}

⬇

{
  "password": "d89786faffda5c9"
}

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/users/harrytasker/reset-password"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "password": "d89786faffda5c9"
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/users/harrytasker/reset-password"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "password": "d89786faffda5c9"
}

Delete admin user

idadminUsers.deleteHTTP-onlyDELETE {admin}/users/{username}

Delete admin account.

Parameters

`username`	stringHTTPset in request path The username of the admin user to delete.

Result

HTTP200 OK

`username`	string The username of the deleted platform user.

Deleting an admin user

{}

⬇

{
  "username": "harrytasker"
}

curl -i -X DELETE "https://lead.pryv.me/users/harrytasker"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "username": "harrytasker"
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X DELETE "https://lead.pryv.me/users/harrytasker"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "username": "harrytasker"
}

Platform settings

Methods for managing platform settings.

Retrieve platform settings

idsettings.getHTTP-onlyGET {admin}/admin/settings

Retrieves the platform settings.

Result

HTTP200 OK

`settings`	object The platform settings.

Fetching the platform settings. The result hereafter only display a small part of the settings.

{}

⬇

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        },
        "TRUSTED_APPS": {
          "value": "*@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*",
          "description": "Web pages authorized to run login API call.  See https://api.pryv.com/reference-full/#trusted-apps-verification.  You can remove the ones not related to your platform if you are not using Pryv's default apps The format is comma-separated list of {trusted-app-id}@{origin} pairs. Origins and appIds accept '*' wildcards, but never use wildcard appIds in production. Example: *@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*"
        }
      }
    }
  }
}

curl -i "https://lead.pryv.me/admin/settings"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        },
        "TRUSTED_APPS": {
          "value": "*@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*",
          "description": "Web pages authorized to run login API call.  See https://api.pryv.com/reference-full/#trusted-apps-verification.  You can remove the ones not related to your platform if you are not using Pryv's default apps The format is comma-separated list of {trusted-app-id}@{origin} pairs. Origins and appIds accept '*' wildcards, but never use wildcard appIds in production. Example: *@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*"
        }
      }
    }
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i "https://lead.pryv.me/admin/settings"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        },
        "TRUSTED_APPS": {
          "value": "*@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*",
          "description": "Web pages authorized to run login API call.  See https://api.pryv.com/reference-full/#trusted-apps-verification.  You can remove the ones not related to your platform if you are not using Pryv's default apps The format is comma-separated list of {trusted-app-id}@{origin} pairs. Origins and appIds accept '*' wildcards, but never use wildcard appIds in production. Example: *@https://*.DOMAIN*, *@https://pryv.github.io*, *@https://*.rec.la*"
        }
      }
    }
  }
}

Update platform settings

idsettings.updateHTTP-onlyPUT {admin}/admin/settings

Updates the platform settings and saves them.

Parameters

`update`	objectHTTPrequest body New values for the platform settings.

Result

HTTP200 OK

`settings`	object The updated platform settings.

Specific errors

`invalid-input`	HTTP`400` The configuration format is invalid.

Updating the event types URL. The result hereafter only highlights the modified setting.

{
  "API_SETTINGS": {
    "settings": {
      "EVENT_TYPES_URL": {
        "value": "https://my-service/event-types/flat.json"
      }
    }
  }
}

⬇

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        }
      }
    }
  }
}

curl -i -X PUT -H 'Content-Type: application/json' -d '{"API_SETTINGS":{"settings":{"EVENT_TYPES_URL":{"value":"https://my-service/event-types/flat.json"}}}}' "https://lead.pryv.me/admin/settings"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        }
      }
    }
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X PUT -H 'Content-Type: application/json' -d '{"API_SETTINGS":{"settings":{"EVENT_TYPES_URL":{"value":"https://my-service/event-types/flat.json"}}}}' "https://lead.pryv.me/admin/settings"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "settings": {
    "API_SETTINGS": {
      "name": "API settings",
      "settings": {
        "EVENT_TYPES_URL": {
          "value": "https://my-service/event-types/flat.json",
          "description": "URL of the file listing the validated Event types. See: https://api.pryv.com/faq-api/#event-types"
        }
      }
    }
  }
}

Apply settings changes

idsettings.notifyHTTP-onlyPOST {admin}/admin/notify

Reboots desired services with latest platform settings.

Parameters

`services`	array of stringsoptional The Pryv.io services to reboot. If empty, reboots all Pryv.io services. See your configuration’s docker-compose file for the list of services.

Result

HTTP200 OK

successes

Machines successfully updated.

`url`	string The url of the machine.
`role`	string The role of the machine (core, static, reg).

failures

Machines failed to update.

`url`	string The url of the machine.
`role`	string The role of the machine (core, static, reg).
`error`	object The error information.

Rebooting the DNS service with the latest settings.

{
  "services": [
    "dns"
  ]
}

⬇

{
  "successes": [
    {
      "url": "https://co1.pryv.li",
      "role": "core"
    },
    {
      "url": "config-follower:6000",
      "role": "reg-master"
    },
    {
      "url": "https://sw.pryv.li",
      "role": "static"
    }
  ],
  "failures": []
}

curl -i -X POST -H 'Content-Type: application/json' -d '{"services":["dns"]}' "https://lead.pryv.me/admin/notify"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "successes": [
    {
      "url": "https://co1.pryv.li",
      "role": "core"
    },
    {
      "url": "config-follower:6000",
      "role": "reg-master"
    },
    {
      "url": "https://sw.pryv.li",
      "role": "static"
    }
  ],
  "failures": []
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{"services":["dns"]}' "https://lead.pryv.me/admin/notify"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "successes": [
    {
      "url": "https://co1.pryv.li",
      "role": "core"
    },
    {
      "url": "config-follower:6000",
      "role": "reg-master"
    },
    {
      "url": "https://sw.pryv.li",
      "role": "static"
    }
  ],
  "failures": []
}

Retrieve platform migrations

idmigrations.getHTTP-onlyGET {admin}/admin/migrations

Retrieves the available platform settings migrations. To apply them use Apply configuration migrations.

Result

HTTP200 OK

migrations

Available migrations.

`versionsFrom`	array of versions The list of versions it upgrades from.
`versionTo`	string The version it upgrades to.

Fetching available migrations for platform version 1.6.17

{}

⬇

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

curl -i "https://lead.pryv.me/admin/migrations"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

Only available for HTTP REST

Only available for HTTP REST

curl -i "https://lead.pryv.me/admin/migrations"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

Apply configuration migrations

idmigrations.applyHTTP-onlyPOST {admin}/admin/migrations/apply

Apply the available platform configuration migrations. This will upgrade your platform.yml file to the latest available version. Use Retrieve platform migrations to see available migrations.

Result

HTTP200 OK

migrations

Available migrations.

`versionsFrom`	array of versions The list of versions it upgrades from.
`versionTo`	string The version it upgrades to.

Applying available migrations from platform version 1.6.17 to 1.7.0

{}

⬇

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/admin/migrations/apply"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X POST -H 'Content-Type: application/json' -d '{}' "https://lead.pryv.me/admin/migrations/apply"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "migrations": [
    {
      "versionsFrom": [
        "1.6.15",
        "1.6.16",
        "1.6.17",
        "1.6.18",
        "1.6.19",
        "1.6.20"
      ],
      "versionTo": "1.6.21"
    },
    {
      "versionsFrom": [
        "1.6.21"
      ],
      "versionTo": "1.6.22"
    },
    {
      "versionsFrom": [
        "1.6.22"
      ],
      "versionTo": "1.6.23"
    },
    {
      "versionsFrom": [
        "1.6.23"
      ],
      "versionTo": "1.7.0"
    }
  ]
}

Platform users

Methods for managing platform users.

Retrieve platform user information

idplatformUsers.getOneHTTP-onlyGET {admin}/platform-users/{username}

Retrieves the platform user’s information.

Parameters

`username`	stringHTTPset in request path The username of the platform user.

Result

HTTP200 OK

`user`	platform user The platform user’s information.

Fetching the platform settings. The result hereafter only display a small part of the settings.

{}

⬇

{
  "user": {
    "username": "aiuwvd981b298dn8",
    "email": "jericho@pryv.com",
    "language": "en",
    "invitationToken": "undefined",
    "referer": "null",
    "id": "ck6j759f000011ps2octzo1ds",
    "registeredTimestamp": "1581504836193",
    "server": "co1.pryv.li",
    "registeredDate": "Wed, 12 Feb 2020 10:53:56 GMT"
  }
}

curl -i "https://lead.pryv.me/platform-users/${username}"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "aiuwvd981b298dn8",
    "email": "jericho@pryv.com",
    "language": "en",
    "invitationToken": "undefined",
    "referer": "null",
    "id": "ck6j759f000011ps2octzo1ds",
    "registeredTimestamp": "1581504836193",
    "server": "co1.pryv.li",
    "registeredDate": "Wed, 12 Feb 2020 10:53:56 GMT"
  }
}

Only available for HTTP REST

Only available for HTTP REST

curl -i "https://lead.pryv.me/platform-users/${username}"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "user": {
    "username": "aiuwvd981b298dn8",
    "email": "jericho@pryv.com",
    "language": "en",
    "invitationToken": "undefined",
    "referer": "null",
    "id": "ck6j759f000011ps2octzo1ds",
    "registeredTimestamp": "1581504836193",
    "server": "co1.pryv.li",
    "registeredDate": "Wed, 12 Feb 2020 10:53:56 GMT"
  }
}

Delete user

idplatformUsers.deleteHTTP-onlyDELETE {admin}/platform-users/{username}

Delete user account from the Pryv.io platform. This deletion is final.

Parameters

`username`	stringHTTPset in request path The username of the platform user to delete.

Result

HTTP200 OK

`username`	string The username of the deleted platform user.

Deleting a platform user

{}

⬇

{
  "username": "dutch"
}

curl -i -X DELETE "https://lead.pryv.me/platform-users/dutch"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "username": "dutch"
}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X DELETE "https://lead.pryv.me/platform-users/dutch"

⬇

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{
  "username": "dutch"
}

Deactivate MFA for user

idplatformUsers.deactivateMFAHTTP-onlyDELETE {admin}/platform-users/{username}/mfa

Deactivate MFA for a user account from the Pryv.io platform.

Parameters

`username`	stringHTTPset in request path The username of the platform user for whom to deactivate MFA.

Result

HTTP204 No Content

Deactivating MFA for a platform user

{}

⬇

{}

curl -i -X DELETE "https://lead.pryv.me/platform-users/palmer/mfa"

⬇

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{}

Only available for HTTP REST

Only available for HTTP REST

curl -i -X DELETE "https://lead.pryv.me/platform-users/palmer/mfa"

⬇

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8
API-Version: 1.9.0

{}

Data structure

Admin user

An admin user’s information.

`username`	string An admin user’s username.
`permissions`	array of strings An admin user’s permissions

An admin user.

{
  "username": "admin",
  "permissions": {
    "users": [
      "read",
      "create",
      "delete",
      "resetPassword",
      "changePermissions"
    ],
    "settings": [
      "read",
      "update"
    ],
    "platformUsers": [
      "read",
      "delete"
    ]
  }
}

Admin permissions

An admin user’s permissions.

`users`	array of strings Permissions over admin users. Available permissions: `read`, `create`, `delete`, `resetPassword`, `changePermissions`.
`settings`	array of strings Permissions over platform settings. Available permissions: `read`, `update`.
`platformUsers`	array of strings Permissions over platform users. Available permissions: `read`, `delete`.

An admin user.

{
  "username": "admin",
  "permissions": {
    "users": [
      "read",
      "create",
      "delete",
      "resetPassword",
      "changePermissions"
    ],
    "settings": [
      "read",
      "update"
    ],
    "platformUsers": [
      "read",
      "delete"
    ]
  }
}

Platform user

A platform user’s information.

`username`	string The platform user’s username.
`email`	string The platform user’s email.
`language`	string The platform user’s preferred language.
`invitationToken`	string The invitation token provided at registration by the platform user.
`referer`	string The referer provided at registration by the platform user.
`registeredTimestamp`	string The UNIX timestamp of the platform user’s registration.
`server`	string The URL of the core machine where the platform user’s data is stored.
`registeredDate`	string The readable timestamp of the platform user’s registration.

A platform user.

{
  "username": "aiuwvd981b298dn8",
  "email": "jericho@pryv.com",
  "language": "en",
  "invitationToken": "undefined",
  "referer": "null",
  "id": "ck6j759f000011ps2octzo1ds",
  "registeredTimestamp": "1581504836193",
  "server": "co1.pryv.li",
  "registeredDate": "Wed, 12 Feb 2020 10:53:56 GMT"
}

Admin reference

Basics

Administration service

Authorization

API methods

Authentication

Login user

Parameters

Result

Logout user

Result

Admin users

Retrieve admin users information

Parameters

Result

Retrieve admin user information

Parameters

Result

Create an admin user

Parameters

Result

Update an admin user's permissions

Parameters

Result

Reset an admin user's password

Parameters

Result

Delete admin user

Parameters

Result

Platform settings

Retrieve platform settings

Result

Update platform settings

Parameters

Result

Specific errors

Apply settings changes

Parameters

Result

Retrieve platform migrations

Result

Apply configuration migrations

Result

Platform users

Retrieve platform user information

Parameters

Result

Delete user

Parameters

Result

Deactivate MFA for user

Parameters

Result

Data structure

Admin user

Admin permissions

Platform user