grafana-util docs
Home / Manpages / grafana-util-access.1

grafana-util-access.1

Browser-readable rendering of a generated roff manpage.

This page renders the generated roff manpage into readable HTML for browser use. For richer per-subcommand detail, prefer the command-reference pages.

NAME

grafana-util-access - access-management workflows for users, teams, orgs, and service accounts

SYNOPSIS

grafana-util access [SUBCOMMAND] [OPTIONS]

DESCRIPTION

Run the access-management command surface for users, orgs, teams, and service accounts.

  • List live or local access inventory.
  • Create, modify, export, import, diff, or delete access resources.
  • Manage service-account tokens.

WORKFLOW LANES

- Inspect: user, org, team, and service-account inventory reads from live Grafana or local bundles.

- Move: export, import, diff, and snapshot paths for moving or comparing access state.

- Review Before Mutate: lifecycle changes, membership edits, and service-account token rotation.

Choose this page when you need to decide whether the next access task is inventory, migration, or a reviewed mutation.

BEFORE / AFTER

  • Before: access work is split across ad hoc UI clicks, one-off API calls, and hard-to-repeat shell commands.
  • After: the same access surface is grouped into one CLI namespace, so inventory, lifecycle, token work, and snapshots can share the same defaults and review flow.

SUBCOMMANDS

user
List or browse live and local Grafana users, create, modify, export, import, diff, or delete Grafana users. Use when: Inspect users in the current org or in global admin scope.; Inspect users from a live Grafana server or from a local export bundle.; Create or update users with login, email, role, and admin settings.; Export and import user inventory bundles.; Remove users from the org membership or from the global registry.
org
List live or local Grafana organizations, create, modify, export, import, diff, or delete Grafana organizations. Use when: Inspect organization inventory and org users.; Inspect organizations from a live Grafana server or from a local export bundle.; Create a new organization or rename an existing one.; Export or import org bundles between environments.; Remove an organization by id or exact name.
team
List or browse live and local Grafana teams, create, modify, export, import, diff, or delete Grafana teams. Use when: Inspect team inventory and team memberships.; Inspect teams from a live Grafana server or from a local export bundle.; Create or update team membership and admin assignments.; Export or import team bundles.; Remove a team by id or exact name.
service-account
List live or local Grafana service accounts, create, export, import, diff, or delete Grafana service accounts, and manage their tokens. Use when: Inspect service-account inventory.; Inspect service accounts from a live Grafana server or from a local export bundle.; Create or update service-account bundles.; Generate or delete service-account tokens.
service-account token
Add or delete tokens for a Grafana service account. Use when: Create a new service-account token.; Delete an existing service-account token by service-account name or id.

COMMON OPTIONS

  • --profile, --url, --token, --basic-user, --basic-password
  • --prompt-password, --prompt-token, --timeout, --verify-ssl, --insecure, --ca-cert
  • Use the nested subcommands for user, org, team or group, and service-account.

SUCCESS CRITERIA

  • you can tell whether the task belongs to user, org, team, or service-account before you touch production
  • inventory reads are repeatable because profile and auth defaults are explicit
  • token and lifecycle changes are auditable enough to hand off to another operator or to CI

FAILURE CHECKS

  • if a list command returns less than you expect, confirm whether you need admin-level Basic auth instead of a narrower token
  • if a token or membership operation fails, verify that you are on the right org and the right access surface before retrying
  • if the output is going into automation, check the selected --output-format first so the parser knows what shape to expect

EXAMPLES

user: List or browse live and local Grafana users, create, modify, export, import, diff, or delete Grafana users.

grafana-util access user list --profile prod --json

user: List or browse live and local Grafana users, create, modify, export, import, diff, or delete Grafana users.

grafana-util access user list --url http://localhost:3000 --basic-user admin --basic-password admin --scope org --output-format text

org: List live or local Grafana organizations, create, modify, export, import, diff, or delete Grafana organizations.

grafana-util access org list --profile prod --output-format text

team: List or browse live and local Grafana teams, create, modify, export, import, diff, or delete Grafana teams.

grafana-util access team list --url http://localhost:3000 --basic-user admin --basic-password admin --output-format text

service-account: List live or local Grafana service accounts, create, export, import, diff, or delete Grafana service accounts, and manage their tokens.

grafana-util access service-account list --url http://localhost:3000 --basic-user admin --basic-password admin --output-format text

service-account token: Add or delete tokens for a Grafana service account.

grafana-util access service-account token add --profile prod --name deploy-bot --token-name nightly

SEE ALSO

grafana-util(1), grafana-util-profile(1), grafana-util-status(1), grafana-util-overview(1)