mongodbatlas.getOrgInvitation

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

# Data Source: mongodbatlas.OrgInvitation

mongodbatlas.OrgInvitation describes an invitation for a user to join an Atlas organization.

Using getOrgInvitation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getOrgInvitation(args: GetOrgInvitationArgs, opts?: InvokeOptions): Promise<GetOrgInvitationResult>
function getOrgInvitationOutput(args: GetOrgInvitationOutputArgs, opts?: InvokeOptions): Output<GetOrgInvitationResult>

def get_org_invitation(invitation_id: Optional[str] = None,
                       org_id: Optional[str] = None,
                       username: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetOrgInvitationResult
def get_org_invitation_output(invitation_id: Optional[pulumi.Input[str]] = None,
                       org_id: Optional[pulumi.Input[str]] = None,
                       username: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetOrgInvitationResult]

func LookupOrgInvitation(ctx *Context, args *LookupOrgInvitationArgs, opts ...InvokeOption) (*LookupOrgInvitationResult, error)
func LookupOrgInvitationOutput(ctx *Context, args *LookupOrgInvitationOutputArgs, opts ...InvokeOption) LookupOrgInvitationResultOutput

> Note: This function is named LookupOrgInvitation in the Go SDK.

public static class GetOrgInvitation 
{
    public static Task<GetOrgInvitationResult> InvokeAsync(GetOrgInvitationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrgInvitationResult> Invoke(GetOrgInvitationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrgInvitationResult> getOrgInvitation(GetOrgInvitationArgs args, InvokeOptions options)
public static Output<GetOrgInvitationResult> getOrgInvitation(GetOrgInvitationArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getOrgInvitation:getOrgInvitation
  arguments:
    # arguments dictionary

The following arguments are supported:

InvitationId string: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
OrgId string: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

InvitationId string: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
OrgId string: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

invitationId String: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
orgId String: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

invitationId string: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
orgId string: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

invitation_id str: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
org_id str: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

invitationId String: Unique 24-hexadecimal digit string that identifies the invitation in Atlas.
orgId String: Unique 24-hexadecimal digit string that identifies the organization to which you invited the user.
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.

getOrgInvitation Result

The following output properties are available:

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
InviterUsername string: Atlas user who invited username to the organization.
OrgId string
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

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
InviterUsername string: Atlas user who invited username to the organization.
OrgId string
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

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
inviterUsername String: Atlas user who invited username to the organization.
orgId String
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

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
inviterUsername string: Atlas user who invited username to the organization.
orgId string
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

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
inviter_username str: Atlas user who invited username to the organization.
org_id str
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

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
inviterUsername String: Atlas user who invited username to the organization.
orgId String
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

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getOrgInvitation

On this page

On this page

# Data Source: mongodbatlas.OrgInvitation

Using getOrgInvitation

getOrgInvitation Result

Package Details

On this page

On this page