getMembership

Use this data source to find out if a user is a member of your organization, as well as what role they have within it. If the user's membership in the organization is pending their acceptance of an invite, the role they would have once they accept will be returned.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const membershipForSomeUser = github.getMembership({
username: "SomeUser",
});
import pulumi
import pulumi_github as github
membership_for_some_user = github.get_membership(username="SomeUser")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var membershipForSomeUser = Github.GetMembership.Invoke(new()
{
Username = "SomeUser",
});
});
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 {
_, err := github.LookupMembership(ctx, &github.LookupMembershipArgs{
Username: "SomeUser",
}, 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.github.GithubFunctions;
import com.pulumi.github.inputs.GetMembershipArgs;
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 membershipForSomeUser = GithubFunctions.getMembership(GetMembershipArgs.builder()
.username("SomeUser")
.build());
}
}
variables:
membershipForSomeUser:
fn::invoke:
function: github:getMembership
arguments:
username: SomeUser

Return

A collection of values returned by getMembership.

Parameters

argument

A collection of arguments for invoking getMembership.


suspend fun getMembership(organization: String? = null, username: String): GetMembershipResult

Return

A collection of values returned by getMembership.

Parameters

organization

The organization to check for the above username.

username

The username to lookup in the organization.

See also


Return

A collection of values returned by getMembership.

Parameters

argument

Builder for com.pulumi.github.kotlin.inputs.GetMembershipPlainArgs.

See also