User permission mapping (REST)

The AppMon Server offers several RESTful interfaces to manage users. You can also perform the some of these operations in the AppMon Client, at the Roles tab of the Users item from the Dynatrace Server Settings dialog box.

POST Dashboard mapping

Grants access to the specified dashboard for the specified user group.

The request consumes application/json.

POST	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/dashboardmappings AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/dashboardmappings AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/dashboardmappings

Parameters

Parameter	Description	In	Required
groupid	The name of the group to which you want to grant permission.	path	required
body	The body of the request, containing information about dashboards and permissions. See the format description below.	json	optional

Body format

Parameters Example

Element	Type	Description	Required
dashboard	string	Name of the dashboard to grant permissions for or '*' wildcard to match all dashboards.	required
writepermission	boolean	Writing permission flag. `true` if write permissions should be granted in addition to read permissions.	optional
autoopen	boolean	Auto-open flag. true if dashboard should be opened automatically. Cannot be set for default '*' wildcard for all dashboards.	optional

{
  "dashboard": "string",
  "writepermission": false,
  "autoopen": false
}

Response format

Successful request doesn't return any content.

Example

In this example the request grants the access and writing rights for the Incident Dashboard to the sampleGroup user group.

Request URL

POST https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/dashboardmappings

Request body

{
  "dashboard": "Incident Dashboard",
  "writepermission": true,
  "autoopen": false
}

Response code

204

GET Dashboard mapping

Inquires information about dashboard mappings for the specified user group.

The request produces application/json.

GET	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/dashboardmappings AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/dashboardmappings AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/dashboardmappings

Parameters

Parameter	Description	In	Required
groupid	The name of the group you're inquiring.	path	required

Response format

Parameters Example

Element	Type	Description
mappings	Array[`Dashboard Permission Mapping`]	List of dashboard permission mappings.
`Dashboard Permission Mapping` object
dashboard	string	Name of the dashboard or '*' wildcard to match all dashboards.
writepermission	boolean	Writing permission flag. `true` if write permissions is granted in addition to read permissions.
autoopen	boolean	Auto-open flag. true if dashboard should be opened automatically. Cannot be used for default '*' wildcard for all dashboards.

{
  "mappings": [
    {
      "dashboard": "string",
      "writepermission": false,
      "autoopen": false
    }
  ]
}

Example

In this example the request inquires information about dashboard mappings of the sampleGroup user group. The group have the access to the Incident Dashboard with writing rights.

Request URL

GET https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/dashboardmappings

Response body

{
  "mappings": [
    {
      "dashboard": "Incident Dashboard",
      "writepermission": true,
      "autoopen": false
    }
  ]
}

Response code

200

DELETE Dashboard mapping

Deletes access rights to the specified dashboard for the specified user groups. If dashboard is not specified, all dashboard mappings of the group will be deleted.

DELETE

AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/dashboardmappings
AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/dashboardmappings
AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/dashboardmappings

Parameters

Parameter	Description	In	Required
sampleGroup	The name of the user group, where you want to delete access rights.	path	required
dashboard	The name of the dashboard, for which you want to delete access rights. If dashboard is not specified, all dashboard mappings of the group will be deleted.	query	optional

Response format

Successful request doesn't return any content.

Example

In this example the request removes access rights for the Incident Dashboard from the sampleGroup user group.

Request URL

DELETE https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/dashboardmappings?dashboard=Incident%20Dashboard

Response code

204

POST Profile mapping

Creates a System Profile role mapping for the specified user groups. As the result, the group gains access rights from the specified role.

The request consumes application/json.

POST	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/profilemappings AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/profilemappings AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/profilemappings

Parameters

Parameter	Description	In	Required
groupid	The name of the user role to which you want to grant access rights.	path	required
body	The body of the request, containing required permissions. See the format description below.	json	required

Body format

Parameters Example

Element	Type	Description	Required
systemprofile	string	System Profile to grant permissions for, can be either an existing System Profile id, or '*' wildcard, which matches all System Profiles, or '' which matches the personal System Profile of the respective user.	required
role	string	The role whose permissions should be granted for the specified System Profile.	required

{
  "systemprofile": "string",
  "role": "string"
}

Response format

Successful request doesn't return any content.

Example

In this example the request grants access to the sampleProfile System Profile with the Guest role for the sampleGroup user group.

Request URL

POST https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/profilemappings

Request body

{
  "systemprofile": "sampleProfile",
  "role": "Guest"
}

Response code

204

GET Profile mapping

Inquires the information about System Profile permissions of the specified user group.

The request produces application/json.

POST	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/profilemappings AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/profilemappings AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/profilemappings

Parameters

Parameter	Description	In	Required
groupid	The name of the user group you're inquiring.	path	required

Response format

Parameters Example

Element	Type	Description
mappings	Array[`System Profile Role Mapping`]	List of System Profile role mappings.
`System Profile Role Mapping` object
systemprofile	string	System Profile permissions is granted for. Can be either an existing System Profile id, or '*' wildcard, which matches all System Profiles, or '' which matches the personal System Profile of the respective user.
role	`UserRole`	The role whose permissions is granted for the specified System Profile.
`UserRole` object
id	string	The name of the role.
href	strng	The URL of the REST resource of the role.

{
  "mappings": [
    {
      "systemprofile": "string",
      "role": {
        "id": "string",
        "href": "string"
      }
    }
  ]
}

Example

In this example the request inquires System Profile permissions of the sampleGroup user group. The group has the Guest role access to the sampleProfile System Profile.

Request URL

GET https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/profilemappings

Response body

{
  "mappings": [    
    {
      "systemprofile": "sampleProfile",
      "role": {
        "id": "Guest",
        "href": "https://localhost:8021/api/v3/usermanagement/roles/Guest"
      }
    }
  ]
}

Response code

200

DELETE Profile mapping

Deletes access rights to the specified System Profile for the specified user groups. If System Profile is not specified, all System Profile mappings of the group will be deleted.

DELETE

AppMon 2017 May https://{server}:8021/api/v2/usermanagement/groups/{group}/profilemappings
AppMon 2018 April https://{server}:8021/api/v3/usermanagement/groups/{group}/profilemappings
AppMon 2018 October https://{server}:8021/api/v4/usermanagement/groups/{group}/profilemappings

Parameters

Parameter	Description	In	Required
groupid	The name of the user group, where you want to delete access rights.	path	required
profile	The name of the System Profile, for which you want to delete access rights. If no System Profile is specified, all System Profile mappings of the group will be deleted.	query	optional

Response format

Successful request doesn't return any content.

Example

In this example the request deletes access to the sampleProfile System Profile from the sampleGroup user group.

Request URL

DELETE https://localhost:8021/api/v3/usermanagement/groups/sampleGroup/profilemappings?profile=sampleProfile

Response code

204