User roles (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.

GET User roles

Produces a list of all existing user roles on the server.

The request produces application/json.

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

Response format

Parameters Example

Element	Type	Description
roles	Array[`UserRoles`]	List of available user roles.
`UserRoles` object
id	string	The name of the user role.
href	string	The URL of the REST resource of the user role.

{
  "roles": [
    {
      "id": "string",
      "href": "string"
    }
  ]
}

Example

In this example the request inquires all the roles of the locally installed AppMon server.

Request URL

GET https://localhost:8021/api/v3/usermanagement/roles

Response body

{
  "roles": [
    {
      "id": "Administrator",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Administrator"
    },
    {
      "id": "No Permission",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/No%20Permission"
    },
    {
      "id": "PowerUser",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/PowerUser"
    },
    {
      "id": "User",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/User"
    },
    {
      "id": "Guest",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Guest"
    },
    {
      "id": "Web UI Dashboard Viewer",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Web%20UI%20Dashboard%20Viewer"
    },
    {
      "id": "Web UI Business Analyst",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Web%20UI%20Business%20Analyst"
    },
    {
      "id": "Web UI Operator",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Web%20UI%20Operator"
    },
    {
      "id": "Web UI App Owner",
      "href": "https://localhost:8021/api/v3/usermanagement/roles/Web%20UI%20App%20Owner"
    }
  ]
}

Response code

200

PUT User role

Creates a new user role with specified parameters. If such a role already exists, it will be overwritten.

The request consumes application/json.

PUT	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role} AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role} AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}

Parameters

Parameter	Description	In	Required
roleid	The name of the new role.	path	required
body	The body of the request, containing role description. See the format description below.	json	optional

Body format

Parameters Example

Element	Type	Description	Required
description	string	Short description of the role.	optional

{
  "description": "string"
}

Response format

Successful request doesn't return any content.

Example

In this example the request creates the new sampleRole user role.

Request URL

PUT https://localhost:8021/api/v3/usermanagement/roles/sampleRole

Request body

{
  "description": "sample role, created via REST"
}

Response code

201

GET User role

Inquires the information (ID, description, permissions list) about the specified user role.

The request produces application/json.

GET	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role} AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role} AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}

Parameters

Parameter	Description	In	Required
roleid	The name of the role you're inquiring.	path	required

Response format

Parameters Example

Element	Type	Description
id	string	The unique name of the role.
description	string	Short description of the role.
permissions	Array[`UserPermission`]	List of permissions the role holds.
`UserPermission` object
id	string	The name of the permission.
href	string	The URL to the REST resource of the user role.

{
  "id": "string",
  "description": "string",
  "permissions": [
    {
      "id": "string",
      "href": "string"
    }
  ]
}

Example

In this example the request inquires the information about the Guest user role.

Request URL

GET https://localhost:8021/api/v3/usermanagement/roles/Guest

Response body

{
  "id": "Guest",
  "description": "Guest User Role",
  "permissions": [
    {
      "id": "AnalyzeSuspension",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/AnalyzeSuspension"
    },
    {
      "id": "AnalyzeSystem",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/AnalyzeSystem"
    },    
    {
      "id": "ShowInfrastructure",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/ShowInfrastructure"
    },
    {
      "id": "AnalyzeMethod",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/AnalyzeMethod"
    },
    {
      "id": "WebuiInfrastructure",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/WebuiInfrastructure"
    },    
    {
      "id": "WebuiApplicationAnalytics",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/WebuiApplicationAnalytics"
    },
    {
      "id": "AnalyzePurePath",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/AnalyzePurePath"
    },
    {
      "id": "AnalyzeTransaction",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/AnalyzeTransaction"
    },  
  ]
}

Response code

200

DELETE User role

Deletes the specified user role.

DELETE

AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role}
AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role}
AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}

Parameters

Parameter	Description	In	Required
roleid	The name of the user role to be deleted.	path	required

Response format

Successful request doesn't return any content.

Example

In this example the request deletes the sampleRole user role.

Request URL

DELETE https://localhost:8021/api/v3/usermanagement/roles/sampleRole

Response code

204

POST User role permission

Assigns permissions to the specified user role. All previously assigned permissions remain valid.

Note

You can only assign permissions, which currently logged in user has.

The request consumes application/json.

POST	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role}/permissions AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role}/permissions AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}/permissions

Parameters

Parameter	Description	In	Required
roleid	The name of the role, to which you want to assign permissions.	path	required
body	The body of the request, containing permissions. See the format description below.	json	required

Body format

Parameters Example

Element	Type	Description	Required
permission	Array[string]	List of permissions to be assigned.	required

{
  "permissions": [
    "string"
  ]
}

Response format

Successful request doesn't return any content.

Example

In this example the request assigns the EditStoredSession and RenameSession permissions to the sampleRole user role. Existing permissions remain unaffected.

Request URL

POST https://localhost:8021/api/v3/usermanagement/roles/sampleRole/permissions

Request body

{
  "permissions": [
    "EditStoredSession", "RenameSession"
  ]
}

Response code

204

PUT User role permission

Assigns permissions to the specified user role. All previously assigned permissions will be overwritten.

Note

You can only assign permissions, which currently logged in user has.

The request consumes application/json.

PUT	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role}/permissions AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role}/permissions AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}/permissions

Parameters

Parameter	Description	In	Required
roleid	The name of the role, to which you want to assign permissions.	path	required
body	The body of the request, containing permissions. See the format description below.	json	required

Body format

Parameters Example

Element	Type	Description	Required
permission	Array[string]	List of permissions to be assigned.	required

{
  "permissions": [
    "string"
  ]
}

Example

In this example the request assigns the WebuiManageAllDashboards, WebuiApplicationAnalytics, and WebuiInfrastructure to the sampleRole user role.

Request URL

PUT https://localhost:8021/api/v3/usermanagement/roles/sampleRole/permissions

Request body

{
  "permissions": [
    "WebuiManageAllDashboards", "WebuiApplicationAnalytics", "WebuiInfrastructure"
  ]
}

Response code

204

GET User role permission

Inquires the list of user role permissions.

The request produces application/json.

GET	AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role}/permissions AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role}/permissions AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}/permissions

Parameters

Parameter	Description	In	Required
roleid	The name of the role you're inquiring.	path	required

Response format

Parameters Example

Element	Type	Description
permissions	Array[`UserRolesPermissions`]	List of permissions.
`UserRolesPermissions` object
id	string	The name of the user role permission.
href	string	The URL of the REST resource of the user role permissions.

{
  "permissions": [
    {
      "id": "string",
      "href": "string"
    }
  ]
}

Example

In this example the request inquires the permission list of the sampleRole user role.

Request URL

Request body

Response body

{
  "permissions": [
    {
      "id": "WebuiApplicationAnalytics",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/WebuiApplicationAnalytics"
    },
    {
      "id": "WebuiManageAllDashboards",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/WebuiManageAllDashboards"
    },
    {
      "id": "WebuiInfrastructure",
      "href": "https://localhost:8021/api/v3/usermanagement/permissions/WebuiInfrastructure"
    }
  ]
}

Response code

200

DELETE User role permission

Deletes all the permissions from the specified user role.

Note

You can only delete permissions, which currently logged in user has.

DELETE

AppMon 2017 May https://{server}:8021/api/v2/usermanagement/roles/{role}/permissions
AppMon 2018 April https://{server}:8021/api/v3/usermanagement/roles/{role}/permissions
AppMon 2018 October https://{server}:8021/api/v4/usermanagement/roles/{role}/permissions

Parameters

Parameter	Description	In	Required
roleid	The name of the role where you want to delete permissions.	path	required

Response format

Successful request doesn't return any content.

Example

In this example the request deletes the permissions of the sampleRole user role.

Request URL

DELETE https://localhost:8021/api/v3/usermanagement/roles/sampleRole/permissions

Response code

204