1. Packages
  2. Grafana Cloud
  3. API Docs
  4. getUsers
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse

grafana.getUsers

Explore with Pulumi AI

Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse
Deprecated: grafana.index/getusers.getUsers has been deprecated in favor of grafana.oss/getusers.getUsers

This data source uses Grafana’s admin APIs for reading users which does not currently work with API Tokens. You must use basic auth. This data source is also not compatible with Grafana Cloud, as it does not allow basic auth.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumi/grafana";
import * as grafana from "@pulumiverse/grafana";

const testAllUsers = new grafana.oss.User("test_all_users", {
    email: "all_users@example.com",
    name: "Testing grafana_users",
    login: "test-grafana-users",
    password: "my-password",
});
const allUsers = grafana.oss.getUsers({});
Copy
import pulumi
import pulumi_grafana as grafana
import pulumiverse_grafana as grafana

test_all_users = grafana.oss.User("test_all_users",
    email="all_users@example.com",
    name="Testing grafana_users",
    login="test-grafana-users",
    password="my-password")
all_users = grafana.oss.get_users()
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana/oss"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oss.NewUser(ctx, "test_all_users", &oss.UserArgs{
			Email:    pulumi.String("all_users@example.com"),
			Name:     pulumi.String("Testing grafana_users"),
			Login:    pulumi.String("test-grafana-users"),
			Password: pulumi.String("my-password"),
		})
		if err != nil {
			return err
		}
		_, err = oss.GetUsers(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumi.Grafana;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var testAllUsers = new Grafana.Oss.User("test_all_users", new()
    {
        Email = "all_users@example.com",
        Name = "Testing grafana_users",
        Login = "test-grafana-users",
        Password = "my-password",
    });

    var allUsers = Grafana.Oss.GetUsers.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.oss.User;
import com.pulumi.grafana.oss.UserArgs;
import com.pulumi.grafana.oss.OssFunctions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testAllUsers = new User("testAllUsers", UserArgs.builder()
            .email("all_users@example.com")
            .name("Testing grafana_users")
            .login("test-grafana-users")
            .password("my-password")
            .build());

        final var allUsers = OssFunctions.getUsers();

    }
}
Copy
resources:
  testAllUsers:
    type: grafana:oss:User
    name: test_all_users
    properties:
      email: all_users@example.com
      name: Testing grafana_users
      login: test-grafana-users
      password: my-password
variables:
  allUsers:
    fn::invoke:
      function: grafana:oss:getUsers
      arguments: {}
Copy

Using getUsers

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUsers(opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(opts?: InvokeOptions): Output<GetUsersResult>
Copy
def get_users(opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
Copy
func GetUsers(ctx *Context, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, opts ...InvokeOption) GetUsersResultOutput
Copy

> Note: This function is named GetUsers in the Go SDK.

public static class GetUsers 
{
    public static Task<GetUsersResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetUsersResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUsersResult> getUsers(InvokeOptions options)
public static Output<GetUsersResult> getUsers(InvokeOptions options)
Copy
fn::invoke:
  function: grafana:index/getUsers:getUsers
  arguments:
    # arguments dictionary
Copy

getUsers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Users List<Pulumiverse.Grafana.Outputs.GetUsersUser>
The Grafana instance's users.
Id string
The provider-assigned unique ID for this managed resource.
Users []GetUsersUser
The Grafana instance's users.
id String
The provider-assigned unique ID for this managed resource.
users List<GetUsersUser>
The Grafana instance's users.
id string
The provider-assigned unique ID for this managed resource.
users GetUsersUser[]
The Grafana instance's users.
id str
The provider-assigned unique ID for this managed resource.
users Sequence[GetUsersUser]
The Grafana instance's users.
id String
The provider-assigned unique ID for this managed resource.
users List<Property Map>
The Grafana instance's users.

Supporting Types

GetUsersUser

Email This property is required. string
The user's email.
Id This property is required. int
The user ID.
IsAdmin This property is required. bool
Whether the user is admin or not.
Login This property is required. string
The user's login.
Name This property is required. string
The user's name.
Email This property is required. string
The user's email.
Id This property is required. int
The user ID.
IsAdmin This property is required. bool
Whether the user is admin or not.
Login This property is required. string
The user's login.
Name This property is required. string
The user's name.
email This property is required. String
The user's email.
id This property is required. Integer
The user ID.
isAdmin This property is required. Boolean
Whether the user is admin or not.
login This property is required. String
The user's login.
name This property is required. String
The user's name.
email This property is required. string
The user's email.
id This property is required. number
The user ID.
isAdmin This property is required. boolean
Whether the user is admin or not.
login This property is required. string
The user's login.
name This property is required. string
The user's name.
email This property is required. str
The user's email.
id This property is required. int
The user ID.
is_admin This property is required. bool
Whether the user is admin or not.
login This property is required. str
The user's login.
name This property is required. str
The user's name.
email This property is required. String
The user's email.
id This property is required. Number
The user ID.
isAdmin This property is required. Boolean
Whether the user is admin or not.
login This property is required. String
The user's login.
name This property is required. String
The user's name.

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse