User management REST

This is a step-by-step workflow guide for how to use the user management REST interface. As a prerequisite, you should be familiar with the user permission management.

The individual steps can be tried out interactively in our REST documentation that comes with the AppMon Server at https://DTSERVER:8021/api-docs/current/. The following overview figure shows where to find the individual endpoints used in each step:

Step 1: Query available permissions

Permissions need to be referred to by their respective ID, the call in the following image lists all available permissions:

Link to REST documentation for this endpoint

Step 2: Create a new role

A new role requires a unique name and optionally a description. Permissions can be assigned with a different call (see step 3).

Link to REST documentation for this endpoint

Step 2a: (Alternatively) Query available roles

To find out the IDs and URLs of already existing roles, they can be listed using the call shown in the following image:

Link to REST documentation for this endpoint

Step 3: Assign permissions to role

Assign additional permissions to a role by sending their respective IDs with the call shown in the following image:

Link to REST documentation for this endpoint

Step 4: Create new user group

A new user group can be assigned a management role already at creation time by referring to the role ID. Additional permissions for System Profiles and dashboards can be granted with different calls (see steps 5 and 6).

Link to REST documentation for this endpoint

Step 4a: (Alternatively) Query available user groups

List the IDs and URLs of already existing user groups using the call shown in the following image:

Link to REST documentation for this endpoint

Step 5: Add System Profile permissions to user group

By default, a wildcard entry lets a newly created user group grant guest role permissions to all System Profiles. To override this permission for an individual System Profile, a different role can be assigned using the call shown in the following image:

Link to REST documentation for this endpoint

Step 5a: Delete System Profile permissions

The default wildcard entry can be deleted using the following call in order to revoke all permissions from System Profiles not explicitly added in step 5. This call can also be used to delete the role assignments for other System Profiles.

Link to REST documentation for this endpoint

Step 6: Add dashboard permissions to user group

By default, a wildcard entry lets a newly created user group grants reading permissions to all dashboards. To customize permissions for a specific dashboard, use the call shown in the following image:

Link to REST documentation for this endpoint

Step 6a: Delete dashboard permissions

The default wildcard entry can be deleted using the following call in order to revoke even reading permissions from dashboards not explicitly added in step 6. This call can also be used to delete the permission configuration of other dashboards.

Link to REST documentation for this endpoint

Step 7: Add user

In order to add a user, an initial password needs to be set using the following call. User groups can later be assigned with a different call (see step 8).

Link to REST documentation for this endpoint

Step 7a: (Alternatively) Query available users

List the IDs and URLs of already existing users using the call shown in the following image:

Link to REST documentation for this endpoint

Step 8: Add user to user groups

A user can be added to existing user groups by referring to their respective IDs in the call shown in the following image:

Link to REST documentation for this endpoint