1. Docs
  2. Reference
  3. API
  4. GitHub
  5. GetCollaborators

GetCollaborators

Use this data source to retrieve the collaborators for a given repository.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Github.GetCollaborators.InvokeAsync(new Github.GetCollaboratorsArgs
        {
            Owner = "example_owner",
            Repository = "example_repository",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_github as github

test = github.get_collaborators(owner="example_owner",
    repository="example_repository")
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const test = pulumi.output(github.getCollaborators({
    owner: "example_owner",
    repository: "example_repository",
}, { async: true }));

Using GetCollaborators

function getCollaborators(args: GetCollaboratorsArgs, opts?: InvokeOptions): Promise<GetCollaboratorsResult>
function  get_collaborators(affiliation=None, owner=None, repository=None, opts=None)
func GetCollaborators(ctx *Context, args *GetCollaboratorsArgs, opts ...InvokeOption) (*GetCollaboratorsResult, error)
public static class GetCollaborators {
    public static Task<GetCollaboratorsResult> InvokeAsync(GetCollaboratorsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Owner string

The organization that owns the repository.

Repository string

The name of the repository.

Affiliation string

Filter collaborators returned by their affiliation. Can be one of: outside, direct, all. Defaults to all.

Owner string

The organization that owns the repository.

Repository string

The name of the repository.

Affiliation string

Filter collaborators returned by their affiliation. Can be one of: outside, direct, all. Defaults to all.

owner string

The organization that owns the repository.

repository string

The name of the repository.

affiliation string

Filter collaborators returned by their affiliation. Can be one of: outside, direct, all. Defaults to all.

owner str

The organization that owns the repository.

repository str

The name of the repository.

affiliation str

Filter collaborators returned by their affiliation. Can be one of: outside, direct, all. Defaults to all.

GetCollaborators Result

The following output properties are available:

Collaborators List<GetCollaboratorsCollaborator>

An Array of GitHub collaborators. Each collaborator block consists of the fields documented below.

Id string

The provider-assigned unique ID for this managed resource.

Owner string
Repository string
Affiliation string
Collaborators []GetCollaboratorsCollaborator

An Array of GitHub collaborators. Each collaborator block consists of the fields documented below.

Id string

The provider-assigned unique ID for this managed resource.

Owner string
Repository string
Affiliation string
collaborators GetCollaboratorsCollaborator[]

An Array of GitHub collaborators. Each collaborator block consists of the fields documented below.

id string

The provider-assigned unique ID for this managed resource.

owner string
repository string
affiliation string
collaborators List[GetCollaboratorsCollaborator]

An Array of GitHub collaborators. Each collaborator block consists of the fields documented below.

id str

The provider-assigned unique ID for this managed resource.

owner str
repository str
affiliation str

Supporting Types

GetCollaboratorsCollaborator

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

EventsUrl string

The GitHub API URL for the collaborator’s events.

FollowersUrl string

The GitHub API URL for the collaborator’s followers.

FollowingUrl string

The GitHub API URL for those following the collaborator.

GistsUrl string

The GitHub API URL for the collaborator’s gists.

HtmlUrl string

The GitHub HTML URL for the collaborator.

Id int

The ID of the collaborator.

Login string

The collaborator’s login.

OrganizationsUrl string

The GitHub API URL for the collaborator’s organizations.

Permission string

The permission of the collaborator.

ReceivedEventsUrl string

The GitHub API URL for the collaborator’s received events.

ReposUrl string

The GitHub API URL for the collaborator’s repositories.

SiteAdmin bool

Whether the user is a GitHub admin.

StarredUrl string

The GitHub API URL for the collaborator’s starred repositories.

SubscriptionsUrl string

The GitHub API URL for the collaborator’s subscribed repositories.

Type string

The type of the collaborator (ex. user).

Url string

The GitHub API URL for the collaborator.

EventsUrl string

The GitHub API URL for the collaborator’s events.

FollowersUrl string

The GitHub API URL for the collaborator’s followers.

FollowingUrl string

The GitHub API URL for those following the collaborator.

GistsUrl string

The GitHub API URL for the collaborator’s gists.

HtmlUrl string

The GitHub HTML URL for the collaborator.

Id int

The ID of the collaborator.

Login string

The collaborator’s login.

OrganizationsUrl string

The GitHub API URL for the collaborator’s organizations.

Permission string

The permission of the collaborator.

ReceivedEventsUrl string

The GitHub API URL for the collaborator’s received events.

ReposUrl string

The GitHub API URL for the collaborator’s repositories.

SiteAdmin bool

Whether the user is a GitHub admin.

StarredUrl string

The GitHub API URL for the collaborator’s starred repositories.

SubscriptionsUrl string

The GitHub API URL for the collaborator’s subscribed repositories.

Type string

The type of the collaborator (ex. user).

Url string

The GitHub API URL for the collaborator.

eventsUrl string

The GitHub API URL for the collaborator’s events.

followersUrl string

The GitHub API URL for the collaborator’s followers.

followingUrl string

The GitHub API URL for those following the collaborator.

gistsUrl string

The GitHub API URL for the collaborator’s gists.

htmlUrl string

The GitHub HTML URL for the collaborator.

id number

The ID of the collaborator.

login string

The collaborator’s login.

organizationsUrl string

The GitHub API URL for the collaborator’s organizations.

permission string

The permission of the collaborator.

receivedEventsUrl string

The GitHub API URL for the collaborator’s received events.

reposUrl string

The GitHub API URL for the collaborator’s repositories.

siteAdmin boolean

Whether the user is a GitHub admin.

starredUrl string

The GitHub API URL for the collaborator’s starred repositories.

subscriptionsUrl string

The GitHub API URL for the collaborator’s subscribed repositories.

type string

The type of the collaborator (ex. user).

url string

The GitHub API URL for the collaborator.

eventsUrl str

The GitHub API URL for the collaborator’s events.

followersUrl str

The GitHub API URL for the collaborator’s followers.

followingUrl str

The GitHub API URL for those following the collaborator.

gistsUrl str

The GitHub API URL for the collaborator’s gists.

html_url str

The GitHub HTML URL for the collaborator.

id float

The ID of the collaborator.

login str

The collaborator’s login.

organizationsUrl str

The GitHub API URL for the collaborator’s organizations.

permission str

The permission of the collaborator.

receivedEventsUrl str

The GitHub API URL for the collaborator’s received events.

reposUrl str

The GitHub API URL for the collaborator’s repositories.

siteAdmin bool

Whether the user is a GitHub admin.

starredUrl str

The GitHub API URL for the collaborator’s starred repositories.

subscriptionsUrl str

The GitHub API URL for the collaborator’s subscribed repositories.

type str

The type of the collaborator (ex. user).

url str

The GitHub API URL for the collaborator.

Package Details

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