mirror of https://github.com/grafana/grafana.git
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
GitHub
parent
c24a4c1803
commit
ec9c3230eb
|
|
@ -8,9 +8,7 @@ weight = 40
|
|||
|
||||
This section includes information for Grafana administrators, team administrators, and users performing administrative tasks:
|
||||
|
||||
- [Change password]({{< relref "change-your-password" >}})
|
||||
- [Change Preferences]({{< relref "preferences" >}})
|
||||
- [Configuration]({{< relref "configuration" >}})
|
||||
- [Configure Docker image]({{< relref "configure-docker" >}})
|
||||
- [Security]({{< relref "security" >}})
|
||||
|
||||
|
|
|
|||
|
|
@ -5,25 +5,52 @@ weight = 50
|
|||
|
||||
# Manage users
|
||||
|
||||
Create users and teams and configure [Permissions]({{< relref "../permissions/_index.md" >}}) to make sure that users only have access to the resources they need.
|
||||
Grafana offers several options for grouping users. Each level has different tools for managing user accounts and different tasks that they can perform.
|
||||
|
||||
Only Administrators can manage users and teams.
|
||||
One of the most important user management tasks is assigning roles, which govern what [permissions]({{< relref "../permissions/_index.md" >}}) a user has. The correct permissions ensure that users have access to only the resources they need.
|
||||
|
||||
## Users
|
||||
## Server
|
||||
|
||||
Users are named accounts in Grafana that can be granted permissions to access resources throughout Grafana.
|
||||
The highest and broadest level of user group in Grafana is the server. Every user with an account in a Grafana instance is a member of the server group.
|
||||
|
||||
- [Add or remove a user]({{< relref "./add-or-remove-user.md" >}})
|
||||
- [Enable or disable a user]({{< relref "./enable-or-disable-user.md" >}})
|
||||
Grafana Server Admins are user accounts that have the Grafana Admin option set to **Yes**. They can manage individual user accounts and organizations on their server.
|
||||
|
||||
Server Admins can:
|
||||
|
||||
- [Manage users]({{< relref "server-admin-manage-users.md" >}})
|
||||
- [Manage organizations]({{< relref "server-admin-manage-orgs.md" >}})
|
||||
|
||||
## Organization
|
||||
|
||||
Organizations are groups of users on a server. Users can belong to one or more organizations, but each user must belong to at least one organization.
|
||||
|
||||
Data sources, plugins, and dashboards are associated with organizations. This means that you can have a server with two organizations, one with a Prometheus data source and another with an InfluxDB data source. Each organization has separate data and dashboards.
|
||||
|
||||
Members of organizations have permissions based on their _role_ in the organization. For more information, refer to [Organization roles]({{< relref "../permissions/organization_roles.md" >}}).
|
||||
|
||||
Organization Admins are user accounts that are assigned the Admin role for an organization. They can manage their users and teams in their organization.
|
||||
|
||||
Organization Admins can:
|
||||
- [Manage users]({{< relref "org-admin/_index.md" >}})
|
||||
- [Manage teams]({{< relref "manage-teams/index.md" >}})
|
||||
|
||||
## Teams
|
||||
|
||||
Teams allow you to grant permissions for a group of users.
|
||||
Teams are groups of users within the same organization. Teams allow you to grant permissions for a group of users. They are most often used to manage [permissions for folders and dashboards]({{< relref "../permissions/dashboard_folder_permissions.md" >}}). Enterprise users can use them to apply [data source permissions]({{< relref "../enterprise/datasource_permissions.md" >}}).
|
||||
|
||||
- [Create or remove a team]({{< relref "./create-or-remove-team.md" >}})
|
||||
- [Add or remove a user from a team]({{< relref "./add-or-remove-user-from-team.md" >}})
|
||||
Teams are mostly managed by Organization Admins. However, if the Grafana server setting [editors_can_admin]({{< relref "../administration/configuration.md#editors_can_admin" >}}) is applied, then users who are assigned the Team Admin role can also manage teams in their organization and users assigned to their teams.
|
||||
|
||||
Team Admins can [Manage teams]({{< relref "manage-teams/index.md" >}}).
|
||||
|
||||
## Users
|
||||
|
||||
Users are named accounts in Grafana with granted permissions to access resources throughout Grafana. All users can manage their own accounts to a limited extent.
|
||||
|
||||
Users can:
|
||||
- [View and edit user profile](user-admin/user-profile.md)
|
||||
- [Change password](user-admin/change-your-password.md)
|
||||
- [Switch organizations](user-admin/switch-org.md)
|
||||
|
||||
## Learn more
|
||||
|
||||
Set up users and teams in our tutorial on how to [Create users and teams](https://grafana.com/tutorials/create-users-and-teams).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,25 +0,0 @@
|
|||
+++
|
||||
title = "Add or remove a user from a team"
|
||||
keywords = ["grafana", "configuration", "documentation", "users",
|
||||
"teams"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Add or remove a user from a team
|
||||
|
||||
This page explains how to add or remove users from teams in Grafana.
|
||||
|
||||
## Add a user to a team
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
|
||||
1. Click the team you want to add the user to.
|
||||
1. Click **Add member**.
|
||||
1. In the **Add team member** box, select the user you want to add to the team.
|
||||
1. Click **Add to team**.
|
||||
|
||||
## Remove a user from a team
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
|
||||
1. Click the team you want to remove the user from.
|
||||
1. Click **X** to the right of the user's name.
|
||||
1. Click **Delete** to confirm.
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
+++
|
||||
title = "Add or remove a user"
|
||||
keywords = ["grafana", "configuration", "documentation", "users"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Add or remove a user
|
||||
|
||||
This page explains how to add or remove user accounts in Grafana.
|
||||
|
||||
For more information, refer to [Users]({{< relref "./_index.md#users" >}}).
|
||||
|
||||
## Add a user
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
|
||||
1. In the Users tab, click **New user**.
|
||||
1. In **Name**, enter the name of the user.
|
||||
1. In **E-mail**, enter the email of the user.
|
||||
1. In **Username**, enter the username that the user will use to log in.
|
||||
1. In **Password**, enter a password. The user can change their password once they log in.
|
||||
1. Click **Create** to create the user account.
|
||||
|
||||
## Remove a user
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
|
||||
1. Click to select the user you want to remove.
|
||||
1. Click **Delete User**.
|
||||
1. Click **Delete user** in the dialog to confirm.
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
+++
|
||||
title = "Create or remove a team"
|
||||
keywords = ["grafana", "configuration", "documentation", "users",
|
||||
"teams"]
|
||||
weight = 400
|
||||
+++
|
||||
|
||||
# Create or remove a team
|
||||
|
||||
Create or remove teams to manage groups of users.
|
||||
|
||||
For more information, refer to [Teams]({{< relref "./_index.md#teams" >}}).
|
||||
|
||||
## Create a team
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
|
||||
1. Click **New team**.
|
||||
1. In **Name**, enter the name of the team.
|
||||
1. Click **Create**.
|
||||
|
||||
## Remove a team
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Configuration** (gear) icon and then click **Teams**.
|
||||
1. Click **X** to the right of the team's name.
|
||||
1. Click **Delete** to confirm.
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
+++
|
||||
title = "Enable or disable a user"
|
||||
keywords = ["grafana", "configuration", "documentation", "users"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
# Enable or disable a user
|
||||
|
||||
This page explains how to enable or disable user accounts in Grafana.
|
||||
|
||||
## Enable a user
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
|
||||
1. Click to select the user you want to enable.
|
||||
1. Click **Enable User**.
|
||||
|
||||
## Disable a user
|
||||
|
||||
1. In the sidebar, hover your mouse over the **Server Admin** (shield) icon and then click **Users**.
|
||||
1. Click to select the user you want to disable.
|
||||
1. Click **Disable User**.
|
||||
1. Click **Disable user** in the dialog to confirm.
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
+++
|
||||
title = "Manage teams"
|
||||
aliases =["/docs/grafana/latest/manage-users/add-or-remove-user-from-team/","/docs/grafana/latest/manage-users/create-or-remove-team/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Manage teams
|
||||
|
||||
A _team_ is a group of users assigned to an organization on a Grafana server. Each user can belong to more than one organization and more than one team. Teams are generally managed by Organization Admins, but they can also be managed by Editors if the [editors_can_admin]({{< relref "../../administration/configuration.md#editors_can_admin" >}}) server setting is set to `true`. For more information, refer to [Organization roles]({{< relref "../../permissions/organization_roles.md" >}}).
|
||||
|
||||
Teams members are assigned one of two permissions:
|
||||
- Member - Required to be a member of the team.
|
||||
- Admin - A member of the team that can also manage team membership, change team permissions, change team settings, and add or delete the team.
|
||||
|
||||
> **Note:** You must have Organization Admin or Team Admin permissions, or Editor permissions with [editors_can_admin]({{< relref "../../administration/configuration.md#editors_can_admin" >}}) selected, in order to perform the tasks described in this page. Team Admins can only perform tasks that apply to their specific team.
|
||||
|
||||
## View team list
|
||||
|
||||
See the complete list of teams in your Grafana organization.
|
||||
|
||||
{{< docs/shared "manage-users/view-team-list.md" >}}
|
||||
|
||||
### Org Admin view
|
||||
|
||||
|
||||
|
||||
### Team Admin view
|
||||
|
||||
|
||||
|
||||
## Create a team
|
||||
|
||||
Add a team to your Grafana organization.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click **New Team**.
|
||||
1. Enter team information:
|
||||
- **Name -** Enter the name of the new team.
|
||||
- **Email -** (Optional) Enter the team email.
|
||||
1. Click **Create**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Add a team member
|
||||
|
||||
Add an existing user account to a team.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the name of the team that you want to add users to.
|
||||
1. Click **Add member**.
|
||||
1. In the **Add team member** list, click the user account that you want to add to the team. You can also type in the field to filter the list.
|
||||
1. Click **Add to team**.
|
||||
1. Repeat the process to add more team members.
|
||||
{{< /docs/list >}}
|
||||
|
||||
|
||||
|
||||
## Remove a team member
|
||||
|
||||
Remove a user account from the team.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the name of the team that you want to remove users from.
|
||||
1. Click the red **X** next to the name of the user that you want to remove from the team and then click **Delete**.
|
||||
{{< /docs/list >}}
|
||||
|
||||
## Set team member permissions
|
||||
|
||||
Change team member permission levels.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the name of the team in which you want to change user permissions.
|
||||
1. In the team member list, find and click the user account that you want to change. You can use the search field to filter the list if necessary.
|
||||
1. Click the **Permission** list, and then click the new user permission level.
|
||||
{{< /docs/list >}}
|
||||
|
||||
|
||||
|
||||
## Delete a team
|
||||
|
||||
Permanently delete the team and all special permissions assigned to it.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the red **X** next to the team that you want to delete and then click **Delete**.
|
||||
{{< /docs/list >}}
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
+++
|
||||
title = "Org admin tasks"
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
# Manage users as an Org Admin
|
||||
|
||||
An _organization_ is a group of users on a Grafana server. Each user can belong to more than one organization. Every member of the organization has a _role_ in that organization that grants them a certain level of permissions. For more information, refer to [Organization roles]({{< relref "../../permissions/organization_roles.md" >}}).
|
||||
|
||||
Organization Admins, also called Org Admins, can manage users in their organization. Some of their tasks overlap with the [Server Admin tasks]({{< relref "../server-admin/_index.md" >}}).
|
||||
|
||||
> **Note:** You must have Admin permissions in an organization in order to perform the tasks described in this page.
|
||||
|
||||
## View organization user account list
|
||||
|
||||
See a complete list of users with accounts in your Grafana organization. If necessary, you can use the search field to filter the list.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
|
||||
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.
|
||||
- **Role -** The organization role currently assigned to the user.
|
||||
|
||||
|
||||
|
||||
## Manage organization invitations
|
||||
|
||||
Organization Admins can invite users to their Grafana organizations and manage invitations. When an invited user signs in to Grafana, a user account is created for them if one does not already exist.
|
||||
|
||||
### Invite user to organization
|
||||
|
||||
Invite or add an existing user account to your organization.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
1. Click **Invite**.
|
||||
1. Enter the following information:
|
||||
- **Email or Username -** Either the email or username that the user will use to sign in to Grafana.
|
||||
- **Name -** (Optional) The value in the **Name** field of the account.
|
||||
- **Role -** Click the organization role to assign this user. For more information, refer to [Organization roles]({{< relref "../../permissions/organization_roles.md" >}}).
|
||||
- **Send invite email**
|
||||
- **Yes -** If your organization has SMTP set up, then Grafana sends an email to the user inviting them to log in to Grafana and join your organization.
|
||||
- **No -** The user is not sent an invitation, but they can sign in to the Grafana server with the email or username that you entered.
|
||||
1. Click **Submit**.
|
||||
|
||||
|
||||
|
||||
### View pending invitations
|
||||
|
||||
Review invitations of users that were invited but have not signed in.
|
||||
|
||||
|
||||
|
||||
> **Note:** The button is only visible if there are unanswered invitations.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
1. Click **Pending Invites**.
|
||||
|
||||
Grafana displays a list of pending invitations. If necessary, you can use the search field to filter the list.
|
||||
|
||||
|
||||
|
||||
### Copy invitation
|
||||
|
||||
SME - What does this do? I see the button, but it does not seem to do anything.
|
||||
|
||||
### Cancel invitation
|
||||
|
||||
Revoke the invitation of a user that was invited but has not logged in.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
1. Click **Pending Invites**.
|
||||
1. Click the red **X** next to the invitation that you want to cancel.
|
||||
|
||||
## Change organization role
|
||||
|
||||
Every user account is assigned an [Organization role]({{< relref "../../permissions/organization_roles.md" >}}). Organization admins can change the role assigned to a user in their organization.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
1. Find the user account for which you want to change the role. Use the search field to filter the list if necessary.
|
||||
1. Click the **Role** list in the user account that you want to change. Grafana displays the list of available roles.
|
||||
1. Click the role that you want to assign.
|
||||
|
||||
## Remove user from organization
|
||||
|
||||
Remove a user account from your organization. This prevents them from accessing the dashboards and data sources associated with the organization, but it does not remove the user account from the server.
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Users**.
|
||||
1. Find the user account that you want to delete. Use the search field to filter the list if necessary.
|
||||
1. Click the red **X** next to remove the user from your organization.
|
||||
|
|
@ -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 >}}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
+++
|
||||
title = "User account tasks"
|
||||
weight = 400
|
||||
+++
|
||||
|
||||
# User account tasks
|
||||
|
||||
Grafana allows you to manage certain aspects of your user account, including the user name, email, and password.
|
||||
|
||||
You can also view important aspects of your account, such as the organizations and roles assigned and the Grafana sessions associated with the account.
|
||||
|
|
@ -2,12 +2,13 @@
|
|||
title = "Change your password"
|
||||
description = "How to change your Grafana password"
|
||||
keywords = ["grafana", "password", "change", "preferences"]
|
||||
weight = 100
|
||||
aliases = ["/docs/grafana/latest/administration/change-your-password/"]
|
||||
weight = 200
|
||||
+++
|
||||
|
||||
# Change your Grafana password
|
||||
|
||||
You can change your password in the Change Password tab.
|
||||
You can change your Grafana password in the Change Password tab.
|
||||
|
||||
> **Note:** If your Grafana instance uses an external authentication provider, then you might not be able to change your password. Contact your Grafana administrator for more information.
|
||||
|
||||
|
|
@ -18,11 +19,3 @@ You can change your password in the Change Password tab.
|
|||
1. Enter your **Old password** to authorize the change.
|
||||
1. Enter your **New password** and then **Confirm password**.
|
||||
1. Click **Change Password**.
|
||||
|
||||
## Admin user management resources
|
||||
|
||||
Grafana admins can use the following tools:
|
||||
|
||||
- Use the [User API]({{< relref "../http_api/user.md" >}}) to change your password programmatically or to manage users.
|
||||
- The [Manage users]({{< relref "../manage-users/_index.md" >}}) section explains how to manage users and teams.
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
+++
|
||||
title = "Switch organization"
|
||||
description = "Change which organization you are logged in with"
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Change the organization you are signed in to
|
||||
|
||||
When you sign in to Grafana, you are always signed in with a particular organization. If you are assigned to multiple organizations, then you might need to switch which organization you are signed in to. For example, if you need to view a dashboard associated with a different org, then you might switch organizations.
|
||||
|
||||
1. Hover your cursor over your user icon in the lower left corner of the screen, then click **Switch**.
|
||||
1. Next to the organization that you want to sign in to, click **Switch to**.
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
+++
|
||||
title = "User account profile"
|
||||
description = "View and edit your Grafana user profile"
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Grafana user account profile
|
||||
|
||||
You can edit and view important information about your Grafana user account, including your assigned organizations, your sessions, and the information associated with your account.
|
||||
|
||||
## Edit your profile
|
||||
|
||||
Your profile includes your name, user name, and email address.
|
||||
|
||||
1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.**
|
||||
1. In the Edit Profile section, you can edit any of the following:
|
||||
- **Name -** Edit this field to change the display name associated with your profile.
|
||||
- **Email -** Edit this field to change the email address associated with your profile.
|
||||
- **Username -** Edit this field to change your user name.
|
||||
1. Click **Save**.
|
||||
|
||||
## View your assigned organizations
|
||||
|
||||
Every user is a member of at least one organization. You can have different roles in every organization that you are a member of.
|
||||
|
||||
1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.**
|
||||
1. Scroll down to the Organizations section.
|
||||
- **Name -** The name of the organizations you are a member of in that Grafana instance.
|
||||
- **Role -** The role you are assigned in the organization. Refer to [Organization roles]({{< relref "../../permissions/organization_roles.md" >}}) about permissions assigned to each role.
|
||||
- **Current -** Grafana tags the organization that you are currently signed in to as _Current_. If you are part of multiple organizations, then you can click **Select** to switch to that organization.
|
||||
|
||||
## View your Grafana sessions
|
||||
|
||||
Grafana logs your sessions in each Grafana instance. You can review this section if you suspect someone has misused your Grafana credentials.
|
||||
|
||||
1. Navigate to the Preferences tab. Hover your cursor over your user icon in the lower left corner of the screen, and then click **Preferences.**
|
||||
1. Scroll down to the Sessions section. Grafana displays the following:
|
||||
- **Last seen -** How long ago you logged on.
|
||||
- **Logged on -** The date you logged on to the current Grafana instance.
|
||||
- **IP address -** The IP address that you logged on from.
|
||||
- **Browser & OS -** The web browser and operating system used to log on to Grafana.
|
||||
- If you are a Grafana Admin for the instance, then you can revoke a session by clicking the red signout icon in the session row.
|
||||
|
|
@ -11,21 +11,21 @@ weight = 50
|
|||
What you can do in Grafana is defined by the _permissions_ associated with your user account.
|
||||
|
||||
There are three types of permissions:
|
||||
- Permissions granted as a Grafana server admin
|
||||
- Permissions granted as a Grafana Server Admin
|
||||
- Permissions associated with your role in an organization
|
||||
- Permissions granted to a specific folder or dashboard
|
||||
|
||||
You can be granted permissions based on:
|
||||
- Grafana server admin status.
|
||||
- Grafana Server Admin status.
|
||||
- Organization role (Admin, Editor, or Viewer).
|
||||
- Folder or dashboard permissions assigned to your team (Admin, Editor, or Viewer).
|
||||
- Folder or dashboard permissions assigned to your user account (Admin, Editor, or Viewer).
|
||||
- (Grafana Enterprise) Data source permissions. For more information, refer to [Data source permissions]({{< relref "../enterprise/datasource_permissions.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
||||
- (Grafana Cloud) Grafana Cloud has additional roles. For more information, refer to [Grafana Cloud roles and permissions](/docs/grafana-cloud/cloud-portal/cloud-roles/).
|
||||
|
||||
## Grafana server admin
|
||||
## Grafana Server Admin role
|
||||
|
||||
Grafana server admins have the **Grafana Admin** flag enabled on their account. They can access the **Server Admin** menu and perform the following tasks:
|
||||
Grafana server administrators have the **Grafana Admin** flag enabled on their account. They can access the **Server Admin** menu and perform the following tasks:
|
||||
|
||||
- Manage users and permissions.
|
||||
- Create, edit, and delete organizations.
|
||||
|
|
@ -33,6 +33,8 @@ Grafana server admins have the **Grafana Admin** flag enabled on their account.
|
|||
- View Grafana server stats, including total users and active sessions.
|
||||
- Upgrade the server to Grafana Enterprise.
|
||||
|
||||
> **Note:** This role does not exist in Grafana Cloud.
|
||||
|
||||
## Organization roles
|
||||
|
||||
Users can belong to one or more organizations. A user's organization membership is tied to a role that defines what the user is allowed to do in that organization. For more information, refer to [Organization roles]({{< relref "../permissions/organization_roles.md" >}}).
|
||||
|
|
|
|||
|
|
@ -2,12 +2,40 @@
|
|||
title: Shared Content
|
||||
---
|
||||
|
||||
```
|
||||
npm i
|
||||
```
|
||||
Use test.md to experiment and test formats and syntax.
|
||||
|
||||
Syntax to invoke this file would be the following, minus the backslash:
|
||||
## Standalone text
|
||||
|
||||
When you have a chunk of text or steps that stand alone, not part of an ordered or unordered list. This includes headings, paragraphs, full lists, and combinations of those content types.
|
||||
|
||||
The syntax to invoke this file would be the following, minus the backslash:
|
||||
|
||||
```
|
||||
\{{< docs/shared "example" >}}
|
||||
```
|
||||
\{{< docs/shared "example.md" >}}
|
||||
```
|
||||
|
||||
## Part of a list
|
||||
|
||||
When you have steps that you want to use in more than one numbered list. This format does not work as well for unordered lists, but it does work.
|
||||
|
||||
### Ordered list
|
||||
|
||||
Below is an example from the docs, with backslashes added. The initial spaces are not necessary for the numbered list to work and make no difference in the output, but they aid in code readability.
|
||||
|
||||
```
|
||||
\{{< docs/list >}}
|
||||
\{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the user account that you want to edit. If necessary, use the search field to find the account.
|
||||
\{{< /docs/list >}}
|
||||
```
|
||||
|
||||
You cannot use short codes in an ordered list with sublists. The shortcode breaks the sublist indentation.
|
||||
|
||||
### Unordered list
|
||||
|
||||
All unordered list steps included as part of a list will appear as second-level lists (with the hollow circle bullet) rather than first-level lists (solid circle bullet), even if the list is not indented in the shared file or the document file.
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "test.md" >}}
|
||||
- Bullet text
|
||||
{{< /docs/list >}}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: View org list as server admin
|
||||
---
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-org-list.md" >}}
|
||||
1. Click the name of the organization that you want to edit.
|
||||
{{< /docs/list >}}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: View org list as server admin
|
||||
---
|
||||
|
||||
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears.
|
||||
1. Click **Orgs**.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: View user list and search - list format
|
||||
---
|
||||
|
||||
{{< docs/list >}}
|
||||
{{< docs/shared "manage-users/view-server-user-list.md" >}}
|
||||
1. Click the user account that you want to edit. If necessary, use the search field to find the account.
|
||||
{{< /docs/list >}}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: View user list as server admin
|
||||
---
|
||||
|
||||
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears.
|
||||
1. Click **Users**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: View team list
|
||||
---
|
||||
|
||||
1. Hover your cursor over the **Configuration** (gear) icon in the side menu.
|
||||
1. Click **Teams**. Grafana displays the team list.
|
||||
|
|
@ -2,6 +2,6 @@
|
|||
title: Shared Content
|
||||
---
|
||||
|
||||
1. Step one
|
||||
2. Step two
|
||||
3. Step three
|
||||
Intro text
|
||||
- test bullet 1
|
||||
- test bullet 2
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: View user list
|
||||
---
|
||||
|
||||
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears.
|
||||
1. Click **Orgs**.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: View user list
|
||||
---
|
||||
|
||||
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears.
|
||||
1. Click **Users**.
|
||||
1. Click the user account that you want to edit. If necessary, use the search field to find the account.
|
||||
Loading…
Reference in New Issue