get Users
The gitlab.getUsers
data source allows details of multiple users to be retrieved given some optional filter criteria.
Some attributes might not be returned depending on if you're an admin or not. Some available options require administrator privileges. Upstream API: GitLab REST API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = gitlab.getUsers({
sort: "desc",
orderBy: "name",
createdBefore: "2019-01-01",
});
const example-two = gitlab.getUsers({
search: "username",
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.get_users(sort="desc",
order_by="name",
created_before="2019-01-01")
example_two = gitlab.get_users(search="username")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
var example = GitLab.GetUsers.Invoke(new()
{
Sort = "desc",
OrderBy = "name",
CreatedBefore = "2019-01-01",
});
var example_two = GitLab.GetUsers.Invoke(new()
{
Search = "username",
});
});
package main
import (
"github.com/pulumi/pulumi-gitlab/sdk/v7/go/gitlab"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gitlab.GetUsers(ctx, &gitlab.GetUsersArgs{
Sort: pulumi.StringRef("desc"),
OrderBy: pulumi.StringRef("name"),
CreatedBefore: pulumi.StringRef("2019-01-01"),
}, nil)
if err != nil {
return err
}
_, err = gitlab.GetUsers(ctx, &gitlab.GetUsersArgs{
Search: pulumi.StringRef("username"),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetUsersArgs;
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) {
final var example = GitlabFunctions.getUsers(GetUsersArgs.builder()
.sort("desc")
.orderBy("name")
.createdBefore("2019-01-01")
.build());
final var example-two = GitlabFunctions.getUsers(GetUsersArgs.builder()
.search("username")
.build());
}
}
variables:
example:
fn::invoke:
Function: gitlab:getUsers
Arguments:
sort: desc
orderBy: name
createdBefore: 2019-01-01
example-two:
fn::invoke:
Function: gitlab:getUsers
Arguments:
search: username
Return
A collection of values returned by getUsers.
Parameters
A collection of arguments for invoking getUsers.
Return
A collection of values returned by getUsers.
Parameters
Filter users that are active.
Filter users that are blocked.
Search for users created after a specific date. (Requires administrator privileges)
Search for users created before a specific date. (Requires administrator privileges)
Lookup users by external provider. (Requires administrator privileges)
Lookup users by external UID. (Requires administrator privileges)
Order the users' list by id
, name
, username
, created_at
or updated_at
. (Requires administrator privileges)
Search users by username, name or email.
Sort users' list in asc or desc order. (Requires administrator privileges)
See also
Return
A collection of values returned by getUsers.
Parameters
Builder for com.pulumi.gitlab.kotlin.inputs.GetUsersPlainArgs.