Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. OrgInvitation
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.OrgInvitation

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

    Example Usage

    S

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

const test0 = new mongodbatlas.OrgInvitation("test0", {
    username: "test0-acc-username",
    orgId: "<ORG-ID>",
    roles: ["ORG_OWNER"],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test0 = mongodbatlas.OrgInvitation("test0",
    username="test0-acc-username",
    org_id="<ORG-ID>",
    roles=["ORG_OWNER"])

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewOrgInvitation(ctx, "test0", &mongodbatlas.OrgInvitationArgs{
			Username: pulumi.String("test0-acc-username"),
			OrgId:    pulumi.String("<ORG-ID>"),
			Roles: pulumi.StringArray{
				pulumi.String("ORG_OWNER"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test0 = new Mongodbatlas.OrgInvitation("test0", new()
    {
        Username = "test0-acc-username",
        OrgId = "<ORG-ID>",
        Roles = new[]
        {
            "ORG_OWNER",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OrgInvitation;
import com.pulumi.mongodbatlas.OrgInvitationArgs;
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) {
        var test0 = new OrgInvitation("test0", OrgInvitationArgs.builder()
            .username("test0-acc-username")
            .orgId("<ORG-ID>")
            .roles("ORG_OWNER")
            .build());

    }
}

    resources:
  test0:
    type: mongodbatlas:OrgInvitation
    properties:
      username: test0-acc-username
      orgId: <ORG-ID>
      roles:
        - ORG_OWNER

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

const test0 = new mongodbatlas.OrgInvitation("test0", {
    username: "test0-acc-username",
    orgId: "<ORG-ID>",
    roles: [
        "ORG_MEMBER",
        "ORG_BILLING_ADMIN",
    ],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test0 = mongodbatlas.OrgInvitation("test0",
    username="test0-acc-username",
    org_id="<ORG-ID>",
    roles=[
        "ORG_MEMBER",
        "ORG_BILLING_ADMIN",
    ])

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewOrgInvitation(ctx, "test0", &mongodbatlas.OrgInvitationArgs{
			Username: pulumi.String("test0-acc-username"),
			OrgId:    pulumi.String("<ORG-ID>"),
			Roles: pulumi.StringArray{
				pulumi.String("ORG_MEMBER"),
				pulumi.String("ORG_BILLING_ADMIN"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test0 = new Mongodbatlas.OrgInvitation("test0", new()
    {
        Username = "test0-acc-username",
        OrgId = "<ORG-ID>",
        Roles = new[]
        {
            "ORG_MEMBER",
            "ORG_BILLING_ADMIN",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OrgInvitation;
import com.pulumi.mongodbatlas.OrgInvitationArgs;
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) {
        var test0 = new OrgInvitation("test0", OrgInvitationArgs.builder()
            .username("test0-acc-username")
            .orgId("<ORG-ID>")
            .roles(            
                "ORG_MEMBER",
                "ORG_BILLING_ADMIN")
            .build());

    }
}

    resources:
  test0:
    type: mongodbatlas:OrgInvitation
    properties:
      username: test0-acc-username
      orgId: <ORG-ID>
      roles:
        - ORG_MEMBER
        - ORG_BILLING_ADMIN

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

const test1 = new mongodbatlas.OrgInvitation("test1", {
    username: "test1-acc-username",
    orgId: "<ORG-ID>",
    teamsIds: [
        "<TEAM-0-ID>",
        "<TEAM-1-ID>",
    ],
    roles: ["ORG_MEMBER"],
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test1 = mongodbatlas.OrgInvitation("test1",
    username="test1-acc-username",
    org_id="<ORG-ID>",
    teams_ids=[
        "<TEAM-0-ID>",
        "<TEAM-1-ID>",
    ],
    roles=["ORG_MEMBER"])

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewOrgInvitation(ctx, "test1", &mongodbatlas.OrgInvitationArgs{
			Username: pulumi.String("test1-acc-username"),
			OrgId:    pulumi.String("<ORG-ID>"),
			TeamsIds: pulumi.StringArray{
				pulumi.String("<TEAM-0-ID>"),
				pulumi.String("<TEAM-1-ID>"),
			},
			Roles: pulumi.StringArray{
				pulumi.String("ORG_MEMBER"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test1 = new Mongodbatlas.OrgInvitation("test1", new()
    {
        Username = "test1-acc-username",
        OrgId = "<ORG-ID>",
        TeamsIds = new[]
        {
            "<TEAM-0-ID>",
            "<TEAM-1-ID>",
        },
        Roles = new[]
        {
            "ORG_MEMBER",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OrgInvitation;
import com.pulumi.mongodbatlas.OrgInvitationArgs;
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) {
        var test1 = new OrgInvitation("test1", OrgInvitationArgs.builder()
            .username("test1-acc-username")
            .orgId("<ORG-ID>")
            .teamsIds(            
                "<TEAM-0-ID>",
                "<TEAM-1-ID>")
            .roles("ORG_MEMBER")
            .build());

    }
}

    resources:
  test1:
    type: mongodbatlas:OrgInvitation
    properties:
      username: test1-acc-username
      orgId: <ORG-ID>
      teamsIds:
        - <TEAM-0-ID>
        - <TEAM-1-ID>
      roles:
        - ORG_MEMBER

    Create OrgInvitation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrgInvitation(name: string, args: OrgInvitationArgs, opts?: CustomResourceOptions);
    @overload
def OrgInvitation(resource_name: str,
                  args: OrgInvitationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def OrgInvitation(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  org_id: Optional[str] = None,
                  roles: Optional[Sequence[str]] = None,
                  username: Optional[str] = None,
                  teams_ids: Optional[Sequence[str]] = None)
    func NewOrgInvitation(ctx *Context, name string, args OrgInvitationArgs, opts ...ResourceOption) (*OrgInvitation, error)
    public OrgInvitation(string name, OrgInvitationArgs args, CustomResourceOptions? opts = null)
    public OrgInvitation(String name, OrgInvitationArgs args)
public OrgInvitation(String name, OrgInvitationArgs args, CustomResourceOptions options)

    type: mongodbatlas:OrgInvitation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrgInvitationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrgInvitationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrgInvitationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgInvitationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgInvitationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var orgInvitationResource = new Mongodbatlas.OrgInvitation("orgInvitationResource", new()
{
    OrgId = "string",
    Roles = new[]
    {
        "string",
    },
    Username = "string",
    TeamsIds = new[]
    {
        "string",
    },
});

    example, err := mongodbatlas.NewOrgInvitation(ctx, "orgInvitationResource", &mongodbatlas.OrgInvitationArgs{
	OrgId: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Username: pulumi.String("string"),
	TeamsIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var orgInvitationResource = new OrgInvitation("orgInvitationResource", OrgInvitationArgs.builder()
    .orgId("string")
    .roles("string")
    .username("string")
    .teamsIds("string")
    .build());

    org_invitation_resource = mongodbatlas.OrgInvitation("orgInvitationResource",
    org_id="string",
    roles=["string"],
    username="string",
    teams_ids=["string"])

    const orgInvitationResource = new mongodbatlas.OrgInvitation("orgInvitationResource", {
    orgId: "string",
    roles: ["string"],
    username: "string",
    teamsIds: ["string"],
});

    type: mongodbatlas:OrgInvitation
properties:
    orgId: string
    roles:
        - string
    teamsIds:
        - string
    username: string

    OrgInvitation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrgInvitation resource accepts the following input properties:

    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    Roles List<string>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    Username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    TeamsIds List<string>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    Roles []string
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    Username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    TeamsIds []string
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles List<String>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    username String
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    teamsIds List<String>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles string[]
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    teamsIds string[]
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles Sequence[str]
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    username str
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    teams_ids Sequence[str]
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles List<String>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    username String
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    teamsIds List<String>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrgInvitation resource produces the following output properties:

    CreatedAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    ExpiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InvitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    InviterUsername string
    Atlas user who invited username to the organization.
    CreatedAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    ExpiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    Id string
    The provider-assigned unique ID for this managed resource.
    InvitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    InviterUsername string
    Atlas user who invited username to the organization.
    createdAt String
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt String
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    id String
    The provider-assigned unique ID for this managed resource.
    invitationId String
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername String
    Atlas user who invited username to the organization.
    createdAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    id string
    The provider-assigned unique ID for this managed resource.
    invitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername string
    Atlas user who invited username to the organization.
    created_at str
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expires_at str
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    id str
    The provider-assigned unique ID for this managed resource.
    invitation_id str
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviter_username str
    Atlas user who invited username to the organization.
    createdAt String
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt String
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    id String
    The provider-assigned unique ID for this managed resource.
    invitationId String
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername String
    Atlas user who invited username to the organization.

    Look up Existing OrgInvitation Resource

    Get an existing OrgInvitation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrgInvitationState, opts?: CustomResourceOptions): OrgInvitation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        expires_at: Optional[str] = None,
        invitation_id: Optional[str] = None,
        inviter_username: Optional[str] = None,
        org_id: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        teams_ids: Optional[Sequence[str]] = None,
        username: Optional[str] = None) -> OrgInvitation
    func GetOrgInvitation(ctx *Context, name string, id IDInput, state *OrgInvitationState, opts ...ResourceOption) (*OrgInvitation, error)
    public static OrgInvitation Get(string name, Input<string> id, OrgInvitationState? state, CustomResourceOptions? opts = null)
    public static OrgInvitation get(String name, Output<String> id, OrgInvitationState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:OrgInvitation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    ExpiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    InvitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    InviterUsername string
    Atlas user who invited username to the organization.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    Roles List<string>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    TeamsIds List<string>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    Username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    CreatedAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    ExpiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    InvitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    InviterUsername string
    Atlas user who invited username to the organization.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    Roles []string
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    TeamsIds []string
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    Username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    createdAt String
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt String
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    invitationId String
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername String
    Atlas user who invited username to the organization.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles List<String>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    teamsIds List<String>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    username String
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    createdAt string
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt string
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    invitationId string
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername string
    Atlas user who invited username to the organization.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles string[]
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    teamsIds string[]
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    username string
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    created_at str
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expires_at str
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    invitation_id str
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviter_username str
    Atlas user who invited username to the organization.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles Sequence[str]
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    teams_ids Sequence[str]
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    username str
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.
    createdAt String
    Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation.
    expiresAt String
    Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation.
    invitationId String
    Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
    inviterUsername String
    Atlas user who invited username to the organization.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user.
    roles List<String>
    Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have.
    teamsIds List<String>
    An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
    username String
    Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username.

    Import

    ~> IMPORTANT: An organization invitation can not be imported once it has been accepted.

    Import a user’s invitation to an organization by separating the org_id and the username with a hyphen:

    $ pulumi import mongodbatlas:index/orgInvitation:OrgInvitation my_user 1112222b3bf99403840e8934-my_user@mongodb.com

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas