Prerequisites

When using the API, pass the following mandatory fields:

  • authToken - The authentication token from Plixer Scrutinizer that allows access to the API.

  • rm - The runmode for accessing the API. It is specific to each section of the product. user_api will be used for each of the following examples.

  • action - The list of available actions will change with each request. Below is a list of available actions within the user_api run mode:

Action

Description

createUser

Allows the creation of user accounts within Plixer Scrutinizer. You can add the accounts to user groups at the same time.

delUsers

Allows the deletion of user accounts within Plixer Scrutinizer by ID or name.

createUsergroup

Creates user groups. You can add members at the same time.

delUsergroups

Deletes user groups.

membership

Changes usergroup membership. When adding or removing a user, use only either user_id or user_name.

prefs

Makes changes to the user preferences for individual accounts. It contains an array of preferences and new settings.

permissions

Makes changes to a user group’s permissions.

changeUsername

Changes the name of a user account.