community.grafana.grafana_organization_user module – Manage Grafana Organization Users.

Note

This module is part of the community.grafana collection (version 1.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.grafana.

To use it in a playbook, specify: community.grafana.grafana_organization_user.

New in community.grafana 1.6.0

Synopsis

Parameters

Parameter

Comments

client_cert

path

PEM formatted certificate chain file to be used for SSL client authentication.

This file can also include the key as well, and if the key is included, client_key is not required

client_key

path

PEM formatted file that contains your private key to be used for SSL client authentication.

If client_cert contains both the certificate and key, this option is not required.

login

string / required

Username or email.

org_id

integer

Organization ID.

Mutually exclusive with org_name.

Default: 1

org_name

string

Organization name.

Mutually exclusive with org_id.

role

string

User’s role in the organization.

Choices:

  • "viewer" ← (default)

  • "editor"

  • "admin"

state

string

Status of a user’s organization membership.

Choices:

  • "present" ← (default)

  • "absent"

url

aliases: grafana_url

string / required

The Grafana URL.

url_password

aliases: grafana_password

string

The Grafana password for API authentication.

Default: "admin"

url_username

aliases: grafana_user

string

The Grafana user for API authentication.

Default: "admin"

use_proxy

boolean

If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Examples

---
- name: Add user to organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    role: admin

- name: Remove user from organization
  community.grafana.grafana_organization_user:
    url: "{{ grafana_url }}"
    url_username: "{{ grafana_username }}"
    url_password: "{{ grafana_password }}"
    login: john
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

user

complex

Information about the organization user

Returned: when state present

email

string

The User email address

Returned: always

Sample: "['foo.bar@example.com']"

login

string

The User login

Returned: always

Sample: "['batman']"

name

string

The User name (same as login)

Returned: always

Sample: "['batman']"

orgId

integer

The organization id that the team is part of.

Returned: always

Sample: [1]

role

string

The user role in the organization

Returned: always

Can only return:

  • "Viewer"

  • "Editor"

  • "Admin"

Sample: "['Viewer']"

Authors

  • Aliaksandr Mianzhynski (@amenzhinsky)