GetUser

Use this data source to retrieve information about a GitHub user.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Github.GetUser.InvokeAsync(new Github.GetUserArgs
        {
            Username = "example",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_github as github

example = github.get_user(username="example")

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = pulumi.output(github.getUser({
    username: "example",
}, { async: true }));

Using GetUser

function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>

function  get_user(username=None, opts=None)

func GetUser(ctx *Context, args *GetUserArgs, opts ...InvokeOption) (*GetUserResult, error)

public static class GetUser {
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Username string: The username.

Username string: The username.

username string: The username.

username str: The username.

GetUser Result

The following output properties are available:

AvatarUrl string: the user’s avatar URL.
Bio string: the user’s bio.
Blog string: the user’s blog location.
Company string: the user’s company name.
CreatedAt string: the creation date.
Email string: the user’s email.
Followers int: the number of followers.
Following int: the number of following users.
GpgKeys List<string>: list of user’s GPG keys.
GravatarId string: the user’s gravatar ID.
Id string: The provider-assigned unique ID for this managed resource.
Location string: the user’s location.
Login string: the user’s login.
Name string: the user’s full name.
NodeId string
PublicGists int: the number of public gists.
PublicRepos int: the number of public repositories.
SiteAdmin bool: whether the user is a GitHub admin.
SshKeys List<string>: list of user’s SSH keys.
UpdatedAt string: the update date.
Username string

AvatarUrl string: the user’s avatar URL.
Bio string: the user’s bio.
Blog string: the user’s blog location.
Company string: the user’s company name.
CreatedAt string: the creation date.
Email string: the user’s email.
Followers int: the number of followers.
Following int: the number of following users.
GpgKeys []string: list of user’s GPG keys.
GravatarId string: the user’s gravatar ID.
Id string: The provider-assigned unique ID for this managed resource.
Location string: the user’s location.
Login string: the user’s login.
Name string: the user’s full name.
NodeId string
PublicGists int: the number of public gists.
PublicRepos int: the number of public repositories.
SiteAdmin bool: whether the user is a GitHub admin.
SshKeys []string: list of user’s SSH keys.
UpdatedAt string: the update date.
Username string

avatarUrl string: the user’s avatar URL.
bio string: the user’s bio.
blog string: the user’s blog location.
company string: the user’s company name.
createdAt string: the creation date.
email string: the user’s email.
followers number: the number of followers.
following number: the number of following users.
gpgKeys string[]: list of user’s GPG keys.
gravatarId string: the user’s gravatar ID.
id string: The provider-assigned unique ID for this managed resource.
location string: the user’s location.
login string: the user’s login.
name string: the user’s full name.
nodeId string
publicGists number: the number of public gists.
publicRepos number: the number of public repositories.
siteAdmin boolean: whether the user is a GitHub admin.
sshKeys string[]: list of user’s SSH keys.
updatedAt string: the update date.
username string

avatar_url str: the user’s avatar URL.
bio str: the user’s bio.
blog str: the user’s blog location.
company str: the user’s company name.
created_at str: the creation date.
email str: the user’s email.
followers float: the number of followers.
following float: the number of following users.
gpg_keys List[str]: list of user’s GPG keys.
gravatar_id str: the user’s gravatar ID.
id str: The provider-assigned unique ID for this managed resource.
location str: the user’s location.
login str: the user’s login.
name str: the user’s full name.
node_id str
public_gists float: the number of public gists.
public_repos float: the number of public repositories.
site_admin bool: whether the user is a GitHub admin.
ssh_keys List[str]: list of user’s SSH keys.
updated_at str: the update date.
username str

Package Details

Repository: https://github.com/pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetUser

Example Usage

Using GetUser

GetUser Result

Package Details

On This Page