@pulumi/pulumiservice/api/organizationMember.d.ts

[](https://slack.pulumi.com) [](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io

import * as pulumi from "@pulumi/pulumi";
/**
 * Adds an existing Pulumi user to an organization with a built-in role. **Important:** The user must have already signed up for a Pulumi account before they can be added to an organization.
 *
 * This endpoint only assigns built-in roles. To onboard a user with a custom role, use the organization invite flow (`BatchCreateOrgInviteEmail`) and set `roleId` on the invite — the custom role is applied when the user accepts. Alternatively, add the user here with a built-in role and then call `UpdateOrganizationMember` with `fgaRoleId` to reassign.
 *
 * Returns the newly created organization member record. Returns 409 if the user is already a member of the organization.
 */
export declare class OrganizationMember extends pulumi.CustomResource {
    /**
     * Get an existing OrganizationMember resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): OrganizationMember;
    /**
     * Returns true if the given object is an instance of OrganizationMember.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is OrganizationMember;
    /**
     * When the member joined the organization.
     */
    readonly created: pulumi.Output<string>;
    /**
     * The role currently assigned to this member — either a built-in role (member, admin, billingManager) or a custom role. Falls back to the organization's default role if no role is assigned directly.
     */
    readonly fgaRole: pulumi.Output<any>;
    /**
     * KnownToPulumi returns if the organization member has a Pulumi account.
     */
    readonly knownToPulumi: pulumi.Output<boolean>;
    /**
     * Links to the member in the Pulumi Console
     */
    readonly links: pulumi.Output<any | undefined>;
    /**
     * **Deprecated:** Use `fgaRole` instead. The member's built-in role within the organization. For members assigned a custom role, this is the closest built-in projection (`member`, `admin`, or `billingManager`) and may lose detail; `fgaRole` is authoritative.
     */
    readonly role: pulumi.Output<string>;
    /**
     * The user information for this organization member.
     */
    readonly user: pulumi.Output<any>;
    /**
     * VirtualAdmin indicates that the member does not have admin access on the
     * backing identity provider, but does have admin access to the Pulumi organization.
     */
    readonly virtualAdmin: pulumi.Output<boolean>;
    /**
     * Create a OrganizationMember resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: OrganizationMemberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a OrganizationMember resource.
 */
export interface OrganizationMemberArgs {
    /**
     * The organization name
     */
    orgName: pulumi.Input<string>;
    /**
     * The built-in role assigned to the new member. Must be `member`, `admin`, or `billingManager`.
     */
    role: pulumi.Input<string>;
    /**
     * The user login name
     */
    userLogin: pulumi.Input<string>;
}
//# sourceMappingURL=organizationMember.d.ts.map