Rest API – User Groups
Overview
The REST API allows you to work with User Groups in FireScope SDDM using a REST client in lieu of the SDDM user interface. Specifically, you can:
- Retrieve
- Create or Update
- Delete
Retrieve
To retrieve the current information about a User Group as a JSON document, send a GET request with the following URL format:
http://localhost:38050/web_services/usergroup?account=firescope&name=Administrators
Note: Don’t forget to change the domain name (localhost) and query parameter values (account, and name) to match your environment and data.
Query Parameter Descriptions
Parameter | Description | Type | Required |
account | Name of the SDDM Account. | String | Yes |
name | Name of the SDDM User Group. | String | Yes |
Create or Update
To create or update a User Group, POST a JSON document with the specific information for that User Group to the following URL:
http://localhost:38050/web_services/usergroup
Note: Don’t forget to change the domain name (localhost) to match your environment and data.
{
"account_id": "firescope",
"name": "Administrators",
"bpgroup": [
"All BPs"
],
"logicalgroup": [
"Databases",
"Web Servers"
],
"servicegroup": [
"Sales",
"Orders"
],
"users": [
"mbrown",
"jdoe"
]
}
Property Descriptions
Property | Description | Type | Default Value | Required |
account_id | Name of the SDDM Account. | String | Yes | |
name | Name of the SDDM User Group. | String | Yes | |
bpgroup | A list of BP Groups that will allow users access to view and edit Blueprint Groups and their associated Blueprint elements. | String[] | No | |
logicalgroup | A list of Logical Groups that will allow users access to all CIs and related elements (attributes, event definitions, events, etc) under that Logical Group. | String[] | No | |
servicegroup | A list of Service Groups that will allow users access to all Logical Groups, CIs and related elements (attributes, event definitions, events, etc) under that Service Group & its Logical Groups. | String[] | No | |
users | Select which groups this new user will be associated with for access to assets. User group assignment also determine visibility to group shared dashboard pages. | String[] | No |
Delete
To delete a User Group, send an HTTP DELETE request with the same query parameters as the GET request.
See the Retrieve for the URL format and query parameter descriptions.