Users

Create user

Please use <a href="https://developers.piwik.pro/reference/api_users_invited_v2">Invite user</a> instead.<br><br> It adds user.

post/api/users/v2

Request

Base URL
https://example.piwik.pro
Auth
OAuth 2
Client credentials
Token URL/auth/token
TypeScript
https://skmtc.dev/piwik/apis/web-api/docs/api/users/v2/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "data": {
    "attributes": {
      "password": "Secret1337",
      "email": "john@doe.com",
      "role": "USER",
      "language": "en-US"
    }
  }
}

Response

Created

Example response

{
  "data": {
    "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
    "type": "ppms/user",
    "attributes": {
      "email": "john@doe.com",
      "role": "USER",
      "organization": "organization_name",
      "addedAt": "2018-06-25T07:28:52+01:00",
      "language": "en-US"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.