Skip to content

DOC-2767-update-user-management #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 4.2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified modules/admin-portal/images/all-users-updated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/admin-portal/images/proxy-groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 19 additions & 4 deletions modules/admin-portal/pages/management/user-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ Read more at: xref:tigergraph-server:user-access:index.adoc[].

== All Users

The All Users tab displays information on all users.
The All Users tab displays information on all users. The table in the tab displays the following columns:

* *Name*: The username of the user account
* *Proxy User*: Indicates whether the user is a proxy user (Yes/No)
* *Role*: The assigned role(s) for the user, showing both global and graph-specific roles
* *Actions*: Contains buttons to change password and delete the user

image::all-users-updated.png[]

Only users with user or proxy groups management permission can access this tab.
Users with user management permissions (`READ_USER` and `WRITE_USER` privileges) can:

Expand All @@ -42,8 +50,6 @@ Users with proxy groups management permission (`READ_PROXYGROUP`, `WRITE_PROXYGR

To see a list of all privileges, see xref:tigergraph-server:reference:list-of-privileges.adoc[List of Privileges].

image::all-users-updated.png[]

[NOTE]
====
Both native users and proxy users are displayed in the User section.
Expand All @@ -59,12 +65,21 @@ Click image:change-others-password-btn.png[] to edit another user's username and

Click image:delete_btn.png[] to delete a user.

Click a role name in the *Role* column to see all privileges assigned to that role.

image::role-all-privileges.png[]

=== Proxy groups

Proxy groups manage user access based on an aspect of their account identity set up as part of SSO or LDAP.
For example, different proxy groups could correspond to different teams, and each team could be granted different access levels to different graphs.

Click the Proxy Group tab at the left under User to see all proxy groups:
Click the Proxy Group tab at the left under User to see all proxy groups. The table in the tab displays the following columns:

* *Group Name*: The name of the proxy group
* *Proxy Rule*: The rule that defines the proxy group
* *Role*: The assigned role(s) for the proxy group, showing both global and graph-specific roles
* *Actions*: Contains buttons to edit the proxy rule and delete the proxy group

image::proxy-groups.png[]

Expand Down
6 changes: 3 additions & 3 deletions modules/admin-portal/pages/monitoring/queries.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ In the Action column for each query, there are buttons to view the individual qu

You can also the top queries ranked by QPS (queries per second), timeout (fraction of the query calls which timed out and therefore did not finish), and latency (minimum, maximum, and average time to complete a query).

The sections in the Overview tab show the queries in each section over the last five minutes.
The sections in the Overview tab show the queries in each section over the last fifteen minutes.

At any point, click the Refresh icon in the upper right corner of the page to refresh the view with the latest statistics.

== Current Query Performance

The Current Query Performance tab shows the same information as the Current Running Queries section on the Overview page, except not limited to the last five minutes.
The Current Query Performance tab shows the same information as the Current Running Queries section on the Overview page, except not limited to the last fifteen minutes.

== Historic Query Performance

Click on the History icon next to any one query in the list to see a graph of its QPS, Timeout, and Latency over the last five minutes.
Click on the History icon next to any one query in the list to see a graph of its QPS, Timeout, and Latency over the last fifteen minutes.