get Users
Use this data source to retrieve information about multiple GitHub users at once.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
// Retrieve information about multiple GitHub users.
const example = github.getUsers({
usernames: [
"example1",
"example2",
"example3",
],
});
export const validUsers = example.then(example => example.logins);
export const invalidUsers = example.then(example => example.unknownLogins);
Content copied to clipboard
import pulumi
import pulumi_github as github
# Retrieve information about multiple GitHub users.
example = github.get_users(usernames=[
"example1",
"example2",
"example3",
])
pulumi.export("validUsers", example.logins)
pulumi.export("invalidUsers", example.unknown_logins)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
// Retrieve information about multiple GitHub users.
var example = Github.GetUsers.Invoke(new()
{
Usernames = new[]
{
"example1",
"example2",
"example3",
},
});
return new Dictionary<string, object?>
{
["validUsers"] = example.Apply(getUsersResult => getUsersResult.Logins),
["invalidUsers"] = example.Apply(getUsersResult => getUsersResult.UnknownLogins),
};
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Retrieve information about multiple GitHub users.
example, err := github.GetUsers(ctx, &github.GetUsersArgs{
Usernames: []string{
"example1",
"example2",
"example3",
},
}, nil)
if err != nil {
return err
}
ctx.Export("validUsers", example.Logins)
ctx.Export("invalidUsers", example.UnknownLogins)
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.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) {
// Retrieve information about multiple GitHub users.
final var example = GithubFunctions.getUsers(GetUsersArgs.builder()
.usernames(
"example1",
"example2",
"example3")
.build());
ctx.export("validUsers", example.logins());
ctx.export("invalidUsers", example.unknownLogins());
}
}
Content copied to clipboard
variables:
# Retrieve information about multiple GitHub users.
example:
fn::invoke:
function: github:getUsers
arguments:
usernames:
- example1
- example2
- example3
outputs:
validUsers: ${example.logins}
invalidUsers: ${example.unknownLogins}
Content copied to clipboard
Return
A collection of values returned by getUsers.
Parameters
argument
A collection of arguments for invoking getUsers.
Return
A collection of values returned by getUsers.
Parameters
usernames
List of usernames.
See also
Return
A collection of values returned by getUsers.
Parameters
argument
Builder for com.pulumi.github.kotlin.inputs.GetUsersPlainArgs.