Docs: Org, Team, and User Admin (#30756)
* Update _index.md * Update _index.md * Create server-admin-manage-users.md * content updates * Update server-admin-manage-users.md * content update * testing single sourcing * Update server-admin-manage-users.md * deleted index, updated sharing command * Update server-admin-manage-users.md * added index files to folders * Update _index.md * added task lists * Update server-admin-manage-users.md * working on single sourcing tests * content updates * Update server-admin-manage-users.md * Update server-admin-manage-users.md * Update server-admin-manage-users.md * add server admin manage orgs file * Update _index.md * Update _index.md * Content updates * Update server-admin-manage-orgs.md * Update server-admin-manage-users.md * Delete menu.yaml * Update _index.md * Update server-admin-manage-users.md * deleted old files * Update _index.md * temporarily removed some files * Update server-admin-manage-users.md * Made two relref changes to this branch. * Merge branch 'master' into docs-update-manage-users * Update server-admin-manage-orgs.md * Update server-admin-manage-users.md * add snippets and content changes * Content updates * Update server-admin-manage-users.md * Update server-admin-manage-orgs.md * added folders * content updates * Update server-admin-manage-users.md * Update server-admin-manage-users.md * testing step format * updated and clarified titles of snippets * Update server-admin-manage-users.md * Update server-admin-manage-users.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update server-admin-manage-users.md * Update server-admin-manage-users.md * content edits * Update _index.md * Update _index.md * Update _index.md * deleted old files * Update _index.md * Update _index.md * Update change-your-password.md * Update _index.md * Update _index.md * Update _index.md * moved files * Added user account profile topic * Update _index.md * Update _index.md * minor edits * update shortcodes * minor updates * Delete view-server-user-list-list.md * testing and updating shortcodes * edited content for single sourcing * Update example.md * added new snippet * updated content * Update _index.md * Added links * Content updates * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update docs/sources/manage-users/_index.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update _index.md Co-authored-by: achatterjee-grafana <aparajita.chatterjee@grafana.com> Co-authored-by: Robby Milo <robbymilo@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
This commit is contained in:
Diana Payton
co-authored by
achatterjee-grafana
Ursula Kallio
achatterjee-grafana
Robby Milo
achatterjee-grafana
Ursula Kallio
achatterjee-grafana
Robby Milo
parent
c24a4c1803
commit
ec9c3230eb
@@ -0,0 +1,14 @@
|
||||
+++
|
||||
title = "Server admin tasks"
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Server admin tasks
|
||||
|
||||
Grafana Server Admins use the **Server Admin** menu to manage user accounts and organizations set up on the Grafana server.
|
||||
|
||||
They perform tasks described in the following pages:
|
||||
|
||||
- [Manage users as a Server Admin]({{< relref "server-admin-manage-users.md" >}}) - Describes user management tasks that Grafana Server Admins can perform.
|
||||
- [Manage organizations as a Server Admin]({{< relref "server-admin-manage-orgs.md" >}}) - Describes organization management tasks that Grafana Server Admins can perform.
|
||||
- [User API]({{< relref "../../http_api/user.md" >}}) - Manage users or change passwords programmatically.
|
||||
@@ -0,0 +1,94 @@
|
||||
+++
|
||||
title = "Manage organization"
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
# Manage organizations as a Server Admin
|
||||
|
||||
This topic explains organization management tasks performed by Grafana Server Admins.
|
||||
|
||||
In order to perform any of these tasks, you must be logged in to Grafana on an account with Grafana Server Admin permissions. For more information about Grafana Admin permissions, refer to [Grafana Server Admin role]({{< relref "../../permissions/_index.md#grafana-server-admin-role" >}})
|
||||
|
||||
> **Note:** The Grafana Server Admin role does not exist in Grafana Cloud. Grafana Cloud users cannot perform tasks listed in this section.
|
||||
|
||||
## View organization list
|
||||
|
||||
See a complete list of organizations set up on your Grafana server.
|
||||
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
|
||||
Grafana displays all organizations set up on the server, listed in alphabetical order by organization name. The following information is displayed:
|
||||
- **Id -** The ID number of the organization.
|
||||
- **Name -** The name of the organization.
|
||||
|
||||
|
||||
|
||||
## Create organization
|
||||
|
||||
Add an organization to your Grafana server.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
1. Click **+ New org**.
|
||||
1. Enter the name of the new organization and then click **Create**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
Two things happen:
|
||||
- Grafana creates a new organization with you as the sole member and Admin.
|
||||
- Grafana opens the new organization [Preferences tab]({{< relref "../../administration/preferences.md" >}}).
|
||||
|
||||
You can now add users or perform other Organization Admin tasks.
|
||||
|
||||
## Delete organization
|
||||
|
||||
Permanently remove an organization from your Grafana server.
|
||||
|
||||
**Warning:** Deleting the organization also deletes all teams and dashboards for this organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
1. Click the red **X** next to the organization that you want to remove.
|
||||
1. Click **Delete**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Edit an organization
|
||||
|
||||
Grafana Server Admins can perform some organization management tasks that are almost identical to Organization Admin tasks, just accessed from a different menu path.
|
||||
|
||||
|
||||
|
||||
### View organization members and roles
|
||||
|
||||
See which user accounts are assigned to the organization and their assigned roles.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
1. Click the name of the organization for which you want to view members.
|
||||
1. Scroll down to the Organization Users section. User accounts are displayed in alphabetical order.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Change organization name
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
|
||||
1. In the **Name** field, type the new organization name.
|
||||
1. Click **Update**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Change organization member role
|
||||
|
||||
Change the organization role assigned to a user account that is assigned to the organization you are editing.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
|
||||
1. In the Organization Users section, locate the user account that you want to change the role of.
|
||||
1. In the **Role** field, select the new role that you want to assign.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Remove a user from an organization
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list-and-edit.md" >}}
|
||||
1. In the Organization Users section, locate the user account that you want to change the role of.
|
||||
1. Click the red **X** next to the user account listing and then click **Delete**.
|
||||
{{< /docs/list >}}
|
||||
@@ -0,0 +1,224 @@
|
||||
+++
|
||||
title = "Manage users"
|
||||
weight = 100
|
||||
aliases =["/docs/grafana/latest/manage-users/add-or-remove-user/","/docs/grafana/latest/manage-users/enable-or-disable-user/"]
|
||||
+++
|
||||
|
||||
# Manage users as a Server Admin
|
||||
|
||||
This topic explains user management tasks performed by Grafana Server Admins.
|
||||
|
||||
In order to perform any of these tasks, you must be logged in to Grafana on an account with Grafana Server Admin permissions. For more information about Grafana Admin permissions, refer to [Grafana Server Admin role]({{< relref "../../permissions/_index.md#grafana-server-admin-role" >}})
|
||||
|
||||
> **Note:** The Grafana Server Admin role does not exist in Grafana Cloud. Grafana Cloud users cannot perform tasks listed in this section.
|
||||
|
||||
## View the server user account list
|
||||
|
||||
See a complete list of users with accounts on your Grafana server.
|
||||
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
|
||||
Grafana displays all user accounts on the server, listed in alphabetical order by user name. The following information is displayed:
|
||||
|
||||
- **Login -** The value in the **Username** field of the account.
|
||||
- **Email -** The email associated with the user account.
|
||||
- **Name -** The value in the **Name** field of the account.
|
||||
- **Seen -** How long ago the user logged in. If they have never logged in, then the default longest time (10y) is displayed.
|
||||
- **Server Admin status -** If the user account has **Grafana Admin** option set, then a shield icon is displayed.
|
||||
- **Account status -** If the account is disabled, then the **Disabled** label is displayed.
|
||||
|
||||
|
||||
|
||||
## View user account details
|
||||
|
||||
See all details associated with a specific user account.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the user account you wish to view. If necessary, use the search field at the top of the tab to search for the specific user account that you need.
|
||||
{{< /docs/list >}}
|
||||
|
||||
Each user account contains the following sections.
|
||||
|
||||
### User information
|
||||
|
||||
This section of the account contains basic user information. Users can change values in these fields on their own account.
|
||||
|
||||
- **Name**
|
||||
- **Email**
|
||||
- **Username**
|
||||
- **Password**
|
||||
|
||||
|
||||
|
||||
### Permissions
|
||||
|
||||
This indicates whether the user account has the Grafana Admin flag applied or not. If it is **Yes**, then the user is a Grafana Server Admin.
|
||||
|
||||
|
||||
|
||||
### Organisations
|
||||
|
||||
This section lists the organizations the user account belongs to and the roles they hold within each organization.
|
||||
|
||||
|
||||
|
||||
### Sessions
|
||||
|
||||
See recent sessions that the user was logged on, including when they logged on and information about the system the logged on with. You can force logouts if necessary.
|
||||
|
||||
|
||||
|
||||
## Add a user account
|
||||
|
||||
Create a new user account at the server level.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click **New user**.
|
||||
1. Enter the following information:
|
||||
- **Name -** Required.
|
||||
- **E-mail -** Optional if a **Username** is entered.
|
||||
- **Username -** Optional if an **E-mail** is entered.
|
||||
- **Password -** Required.
|
||||
1. Click **Create user**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
The user can change all this information after they log in. For instructions, refer to [Grafana user account profile]({{< relref "../user-admin/user-profile.md" >}}) and [Change your password]({{< relref "../user-admin/change-your-password.md" >}}).
|
||||
|
||||
## Edit a user account
|
||||
|
||||
Change information or settings in an individual user account.
|
||||
|
||||
### Edit user information
|
||||
|
||||
Edit information on an existing user account, including the user name, email, username, and password.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the User information section, click **Edit** next to the field that you want to change.
|
||||
1. Enter the new value and then click **Save**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Change the password on a user account
|
||||
|
||||
Users can change their own passwords, but Server Admins can change user passwords as well.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the User information section, click **Edit** next to the **Password** field.
|
||||
1. Enter the new value and then click **Save**. Grafana requires a value at least four characters long in this field.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Delete a user account
|
||||
|
||||
Permanently remove a user account from the server.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Click **Delete User**.
|
||||
1. Click **Delete user** to confirm the action.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Enable or disable a user account
|
||||
|
||||
Temporarily turn on or off account access, but do not remove the account from the server.
|
||||
|
||||
#### Disable user account
|
||||
|
||||
Prevent a user from logging in with this account, but do not delete the account. You might disable an account if a colleague goes on sabbatical.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Click **Disable User**.
|
||||
1. Click **Disable user** to confirm the action.
|
||||
{{< /docs/list >}}
|
||||
|
||||
#### Enable a user account
|
||||
|
||||
Reactivate a disabled user account.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Click **Enable User**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Add/remove Grafana Admin flag
|
||||
|
||||
Give or remove the Grafana Server Admin role from a user account.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the Permissions section, click **Change**.
|
||||
1. Click **Yes** or **No**, depending on whether or not you want this user account to have the Grafana Server Admin role.
|
||||
1. Click **Change**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
The next time this user logs in, their permissions will be updated.
|
||||
|
||||
## Add a user to an organization
|
||||
|
||||
Add a user account to an existing organization. User accounts can belong to multiple organizations, but each user account must belong to at least one organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the Organisations section, click **Add user to organisation**.
|
||||
1. In the **Add to an organization** window, select the **Organisation** that you are adding the user to.
|
||||
1. Select the **Role** that the user should have in the organization.
|
||||
1. Click **Add to organisation**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Remove a user from an organization
|
||||
|
||||
Remove a user account from an organization that it is currently assigned to.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the Organisations section, click **Remove from organisation** next to the organization that you want to remove the user from.
|
||||
1. Click **Confirm removal**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Change organization role
|
||||
|
||||
Change the organization role assigned to a user account.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. In the Organisations section, click **Change role** next to the organization that you want to change the user role for.
|
||||
1. Select the new role and then click **Save**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## View and manage user sessions
|
||||
|
||||
See when a user last logged in and information about how they logged in. You can also force the account to log out of Grafana.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Scroll down to the Sessions section to view sessions associated with this user account.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Force a user to log out of Grafana
|
||||
|
||||
If you suspect a user account is compromised or is no longer authorized to access the Grafana server, then you can force logout the account.
|
||||
|
||||
### Force logout of one device
|
||||
|
||||
Log the user account out of one specific device that is logged in to Grafana.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Scroll down to the Sessions section.
|
||||
1. Click **Force logout** next to the session entry that you want logged out of Grafana.
|
||||
1. Click **Confirm logout**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
### Force logout of all devices
|
||||
|
||||
Log the user account out of all devices that are logged in to Grafana.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list-search.md" >}}
|
||||
1. Scroll down to the Sessions section.
|
||||
1. Click **Force logout from all devices**.
|
||||
1. Click **Force logout**.
|
||||
{{< /docs/list >}}
|
||||
Reference in New Issue
Block a user