PingPlotter Cloud Manual

Users

Overview

The Users API allows you to manage user permissions and access to your account. Integrate this API with your Workforce Management system to automate system access.

GET

GET /users

Retrieve a list of all users in your account.

curl -X 'GET' \
   'https://yoursubdomain.api.pingplotter.cloud/users?filter={emailAddress}' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token'

200 Response

[
   {
      "Name": "string",
      "Id": "string",
      "EmailAddress": "string",
      "Roles": [
         "string"
      ],
      "LastLogin": "025-11-06T22:32:18.062Z",
      "TwoFactorEnabled": true
   }
]

Query Parameters

Parameter Type Notes
filter string Email Address of the user.

POST

POST /users

Add a user to your account.

curl -X 'POST' \
   'https://yoursubdomain.api.pingplotter.cloud/users' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token' \
   -d '{
      "Name": "string",
      "EmailAddress": "string",
      "Roles": [
         "string"
      ]
   }

200 Response

[
   {
      "Name": "string",
      "Id": "string",
      "EmailAddress": "string",
      "Roles": [
         "string"
      ],
      "LastLogin": "025-11-06T22:32:18.062Z",
      "TwoFactorEnabled": true
   }
]

Request Body

Key Type Notes
Name string Name of the user.
EmailAddress string Required. Email Address of user.
Roles string array Options: TargetManagement, SummaryManagement, UserManagement, SettingsManagement, AlertsManagement, AgentManagement, SessionManagement, LiveShareManagement, SidekickManagement. Leave empty to give read-only access. See Users & Permissions for details about each permission set.

PUT

PUT /users/{userId}

Updates user roles. User Roles are a comma-delimited string.

curl -X 'PUT' \
   'https://yoursubdomain.api.pingplotter.cloud/users/{userId}' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token' \
   -d '{
      "Roles": [
         "string"
      ]
   }'

200 Response

[
   {
      "Name": "string",
      "Id": "string",
      "EmailAddress": "string",
      "Roles": [
         "string"
      ],
      "LastLogin": "025-11-06T22:32:18.062Z",
      "TwoFactorEnabled": true
   }
]

Request Body

Key Type Notes
Roles string array Options: TargetManagement, SummaryManagement, UserManagement, SettingsManagement, AlertsManagement, AgentManagement, SessionManagement, LiveShareManagement, SidekickManagement. Leave empty to give read-only access. See Users & Permissions for details about each permission set.

DELETE

DELETE /users/{userId}

Delete a user from your account.

curl -X 'DELETE' \
   'https://yoursubdomain.api.pingplotter.cloud/users/{userId}' \
   -H 'accept: application/json' \
   -H 'X-API-KEY: your_api_token'

200 Response

true