grafana-util docs

grafana-util-access-user.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-user - List or browse live and local Grafana users, create, modify, export, import, diff, or delete Grafana users.

SYNOPSIS

grafana-util access user [OPTIONS]

DESCRIPTION

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

  • 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.

BEFORE / AFTER

  • Before: user lifecycle work is often split across org settings, admin screens, and one-off export or import scripts.
  • After: one namespace covers inventory, create/update, export/import, and targeted removal with the same auth model.

COMMON OPTIONS

list
--input-dir, --scope, --all-orgs, --query, --login, --email, --org-role, --grafana-admin, --with-teams, --page, --per-page, --table, --csv, --json, --yaml, --output-format
browse
--input-dir, --scope, --all-orgs, --current-org, --query, --login, --email, --org-role, --grafana-admin, --page, --per-page
add
--login, --email, --name, --password or --password-file or --prompt-user-password, --org-role, --grafana-admin, --json
modify
--user-id, --login, --email, --set-login, --set-email, --set-name, --set-password or --set-password-file or --prompt-set-password, --set-org-role, --set-grafana-admin, --json
export and diff
--output-dir or --diff-dir, --overwrite, --dry-run, --scope, --with-teams
import
--input-dir, --scope, --replace-existing, --dry-run, --table, --json, --output-format, --yes
delete
--user-id, --login, --email, --scope, --yes, --json

SUCCESS CRITERIA

  • created or modified users have the expected login, email, and role
  • inventory and bundles can be diffed before deletion or migration
  • membership scope stays explicit, so you do not accidentally manage the wrong org or global registry

FAILURE CHECKS

  • if list, add, or delete looks empty or wrong, confirm the selected profile or auth token has the right org or admin scope
  • if create or modify fails, recheck login or email uniqueness and whether the selected scope is org or global
  • if an import does not behave as expected, verify the bundle source and the target scope before retrying

EXAMPLES

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

SEE ALSO

grafana-util(1), grafana-util-access(1)