Rest API – Users

+ More

Table of Contents

Overview Retrieve User Details Example: Query Parameter Descriptions Retrieve the User Schema Create or Update a User Property Descriptions Delete a User

How to create, update, query and delete user profiles in SPM using the FIre Scope REST API.

Overview

The REST API allows you to work with Users in Fire Scope SPM. Specifically, you can:

Retrieve User Details
Retrieve the User Schema
Create or Update a User
Delete a User

Retrieve User Details

To retrieve the current information about a User in SPM, send unique query parameters in a GET request to the following URL:

http://[SPM IP address]:38050/web_services/users?account=[Account name]&name=[User name]

Example:

http://localhost:38050/web_services/...pe&name=tester

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, and name) to match your environment and data.

A JSON response will be returned similar in structure to the payload for Creating a User.

Query Parameter Descriptions

Property	Description	Type	Required
account	Name of the SPM Account.	String	Yes
name	Name of the SPM User.	String	Yes

Retrieve the User Schema

To retrieve the full SPM schema for a User, send the Account name in a GET request to the following URL:

http://[SPM IP address]:38050/web_services/users?account=[Account name]&schema=true

Create or Update a User

To create or update a User, send a POST operation with a JSON document to the following URL:

http://[SPM IP address]:38050/web_services/user

Use the following example as a guide, but note that it may not include all optional properties.

{
   "account_id":"firescope",
   "alias":"bryancan",
   "autologout":0,
   "compliance_access":0,
   "dashboard_refresh":30,
   "default_pageid":null,
   "default_pagetype":0,
   "default_spaceid":null,
   "event_style":1,
   "event_type":"0,1,2",
   "grid_refresh":60000,
   "grid_rows":50,
   "lang":"en_US",
   "name":"Bryan",
   "newshared":0,
"passwd":"P01$044a0baaf782c75ead209b41d72ea0b54fbf5d4d76b01e5f4f1588d7fcb7c2d22de379bff3cf8907288373aa33970a304d7b825d9700efd8b1a1d74e1ea44bed$P01",
   "refresh":30,
   "severity":0,
   "showevent":1,
   "showhint":1,
   "showtree":0,
   "showworkflow":1,
   "status":1,
   "surname":"Cantwell",
   "token_expire":"24 HOUR",
   "treeaddtype":0,
   "type":6,
   "url":"recentdata.php",
   "token_store":{
      "authtime":0,
      "enableimages":0,
      "exptimestamp":0,
      "token":""
   },
   "usrgrp":[
      "Database administrators",
      "FireScope administrators",
      "Guests",
      "Head of IT department",
      "Network administrators",
      "Security specialists",
      "UNIX administrators",
      "WEB administrators"
   ],
   "dateformat":null,
   "timezone":null
}

Property Descriptions

url	Default page displayed when this user logs in.	String	dashboard.php	Yes
token_store PropertyDescriptionTypeDefault ValueRequiredauthtime Number0Noenableimages Number0Noexptimestamp Number0Notoken String No
usrgrp	User Groups this user will be associated with. The primary purpose of User Groups is to define what assets this user can manage.	String		No
dateformat		String		Yes
timezone		String		Yes

Query Parameter Descriptions

Property	Description	Type	Default Value	Required
account_id	Name of the SPM account.	String		Yes
alias	User name this person will use to log in to Fire Scope SPM CMI.	String		Yes
autologout	How many seconds of inactivity will trigger this user’s session to be automatically logged out.	Number	900	Yes
compliance_access		Number	0	No
dashboard_refresh	In seconds, how often the content will be refreshed on the User’s display.	Number	30	No
default_pageid		String		No
default_pagetype		Number	0	No
default_spaceid		String		No
event_style		Number	1	No
event_type		String	0, 1, 2	No
grid_refresh		Number	0	No
grid_rows		Number	0	No
lang	Preferred language used in the SPM user interface.	String	en_gb	Yes
name	User’s first name.	String		Yes
newshared		Number	0	No
passwd	User’s password to log in to Fire Scope SPM CMI.	String		Yes
refresh	Default polling period to refresh data in SPM interface items.Note: You can override this value for Dashboard Lenses by adjusting their individual settings.	Number	30	Yes
severity		Number	0	No
showevent		Number	1	No
showhint		Number	1	No
showtree		Number	0	No
showworkflow		Number	1	No
status	0 = Enabled1 = Disabled	Number	1	Yes
surname	User’s last name.	String		Yes
token_expire		String	24 Hour	No
treeaddtype		Number	1	No
type	Defines what this user can access in Fire Scope SPM. User Access LevelAvailable Menus1 = Dashboard User Only Dashboard2 = Configuration Administrator Dashboard, Analysis, Configuration3 = Fire Scope Administrator All (Dashboard, Analysis, Configuration, Administration)4 = Services Supervisor Dashboard, Analysis5 = Compliance Auditor 6 = Account Administrator	Number	0	Yes
url	Default page displayed when this user logs in.	String	dashboard.php	Yes
token_store PropertyDescriptionTypeDefault ValueRequiredauthtime Number0Noenableimages Number0Noexptimestamp Number0Notoken String No
usrgrp	User Groups this user will be associated with. The primary purpose of User Groups is to define what assets this user can manage.	String		No
dateformat		String		Yes
timezone		String		Yes

Delete a User

To delete a User, send unique query parameters in a DELETE request to the following URL: