@pulumi/github/getMembership.d.ts

A Pulumi package for creating and managing github cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const membershipForSomeUser = github.getMembership({
 *     username: "SomeUser",
 * });
 * ```
 */
export declare function getMembership(args: GetMembershipArgs, opts?: pulumi.InvokeOptions): Promise<GetMembershipResult>;
/**
 * A collection of arguments for invoking getMembership.
 */
export interface GetMembershipArgs {
    /**
     * The organization to check for the above username.
     */
    organization?: string;
    /**
     * The username to lookup in the organization.
     */
    username: string;
}
/**
 * A collection of values returned by getMembership.
 */
export interface GetMembershipResult {
    /**
     * An etag representing the membership object.
     */
    readonly etag: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly organization?: string;
    /**
     * `admin` or `member` -- the role the user has within the organization.
     */
    readonly role: string;
    /**
     * `active` or `pending` -- the state of membership within the organization.  `active` if the member has accepted the invite, or `pending` if the invite is still pending.
     */
    readonly state: string;
    /**
     * The username.
     */
    readonly username: string;
}
/**
 * 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
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as github from "@pulumi/github";
 *
 * const membershipForSomeUser = github.getMembership({
 *     username: "SomeUser",
 * });
 * ```
 */
export declare function getMembershipOutput(args: GetMembershipOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMembershipResult>;
/**
 * A collection of arguments for invoking getMembership.
 */
export interface GetMembershipOutputArgs {
    /**
     * The organization to check for the above username.
     */
    organization?: pulumi.Input<string>;
    /**
     * The username to lookup in the organization.
     */
    username: pulumi.Input<string>;
}