MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.3.0 published on Thursday, Mar 17, 2022 by Pulumi

getProjectInvitation

mongodbatlas.ProjectInvitation describes an invitation to a user to join an Atlas project.

NOTE: Groups and projects are synonymous terms. You may find GROUP-ID in the official documentation.

Using getProjectInvitation

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.

function getProjectInvitation(args: GetProjectInvitationArgs, opts?: InvokeOptions): Promise<GetProjectInvitationResult>
function getProjectInvitationOutput(args: GetProjectInvitationOutputArgs, opts?: InvokeOptions): Output<GetProjectInvitationResult>
def get_project_invitation(invitation_id: Optional[str] = None,
                           project_id: Optional[str] = None,
                           username: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetProjectInvitationResult
def get_project_invitation_output(invitation_id: Optional[pulumi.Input[str]] = None,
                           project_id: Optional[pulumi.Input[str]] = None,
                           username: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetProjectInvitationResult]
func LookupProjectInvitation(ctx *Context, args *LookupProjectInvitationArgs, opts ...InvokeOption) (*LookupProjectInvitationResult, error)
func LookupProjectInvitationOutput(ctx *Context, args *LookupProjectInvitationOutputArgs, opts ...InvokeOption) LookupProjectInvitationResultOutput

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

public static class GetProjectInvitation 
{
    public static Task<GetProjectInvitationResult> InvokeAsync(GetProjectInvitationArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectInvitationResult> Invoke(GetProjectInvitationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProjectInvitationResult> getProjectInvitation(GetProjectInvitationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getProjectInvitation:getProjectInvitation
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InvitationId string

Unique 24-hexadecimal digit string that identifies the invitation in Atlas.

ProjectId string

Unique 24-hexadecimal digit string that identifies the project 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.

ProjectId string

Unique 24-hexadecimal digit string that identifies the project 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.

projectId String

Unique 24-hexadecimal digit string that identifies the project 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.

projectId string

Unique 24-hexadecimal digit string that identifies the project 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.

project_id str

Unique 24-hexadecimal digit string that identifies the project 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.

projectId String

Unique 24-hexadecimal digit string that identifies the project 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.

getProjectInvitation 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 project.

ProjectId 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 following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
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 project.

ProjectId string
Roles []string

Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
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 project.

projectId 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 following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
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 project.

projectId string
roles string[]

Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
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 project.

project_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 following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
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 project.

projectId 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 following options are available:

  • GROUP_OWNER
  • GROUP_CLUSTER_MANAGER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
username String

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.