Skip to main content

Python module and script to invite people fetched from LDAP to Grafana

Project description

grafana-inviter

Azure DevOps builds Azure DevOps tests Azure DevOps coverage

PyPI PyPI - License PyPI - Python Version PyPI - Format PyPI - Status PyUp - Updates

Inviting people to join a Grafana organization is usually done from the Grafana UI. For smaller groups this might be easy but for a larger set of people one rather would like to not fiddle around in the UI and instead do it in an automated fashion.

This tool is intended to send invites to join a new Grafana organization to people obtained from LDAP.

Installation

$ python setup.py install

or

$ pip install grafana-inviter

Usage

  • Copy the example_config.json configuration and adjust it to your needs
  • Generate a Grafana API token with admin privileges (https://<YOUR_GRAFANA_URL>/org/apikeys)
  • Ensure you have a LDAP service account user for searches created
$ grafana-inviter --grafana-token "<YOUR_GF_TOKEN_WITH>" --ldap-user <YOUR_SVC_ACCOUNT_USER> --config config.json --ask-ldap-password
LDAP password:
Sending invite to John Doe (John Doe@acme.org)
{'name': 'John Doe', 'loginOrEmail': 'John.Doe@acme.org', 'role': 'Viewer', 'sendEmail': False, 'orgId': 10}
 > User John.Doe@acme.org is already added to organization
Sending invite to Jane Doe (Jane.Doe@acme.org)
{'name': 'Jane Doe', 'loginOrEmail': 'Jane.Doe@acme.org', 'role': 'Viewer', 'sendEmail': False, 'orgId': 10}
 > Created invite for Jane.Doe@acme.org

Available invite URLs: ['https://<YOUR_GRAFANA_URL>/invite/Vv4Q8SYVyk7ULGpeWvjMXl0iuWLl67']

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grafana-inviter-0.0.5.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file grafana-inviter-0.0.5.tar.gz.

File metadata

  • Download URL: grafana-inviter-0.0.5.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for grafana-inviter-0.0.5.tar.gz
Algorithm Hash digest
SHA256 51f961aad96d23035470abbb394f4ce6580a64bec06c0e145cda60e903ccf711
MD5 368581ce1cbaf8995e5386b1ad313457
BLAKE2b-256 5fe257b1c9c8e50d8a19c75ba1a708881a266dbe08be08f94e8c11d18e65c435

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page