1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Tenantmanagercontrolplane
  5. getSenderInvitations
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Tenantmanagercontrolplane.getSenderInvitations

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides the list of Sender Invitations in Oracle Cloud Infrastructure Tenantmanagercontrolplane service.

Return a (paginated) list of sender invitations.

Example Usage

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

const testSenderInvitations = oci.Tenantmanagercontrolplane.getSenderInvitations({
    compartmentId: compartmentId,
    displayName: senderInvitationDisplayName,
    recipientTenancyId: testTenancy.id,
    state: senderInvitationState,
    status: senderInvitationStatus,
});
Copy
import pulumi
import pulumi_oci as oci

test_sender_invitations = oci.Tenantmanagercontrolplane.get_sender_invitations(compartment_id=compartment_id,
    display_name=sender_invitation_display_name,
    recipient_tenancy_id=test_tenancy["id"],
    state=sender_invitation_state,
    status=sender_invitation_status)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/tenantmanagercontrolplane"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tenantmanagercontrolplane.GetSenderInvitations(ctx, &tenantmanagercontrolplane.GetSenderInvitationsArgs{
			CompartmentId:      compartmentId,
			DisplayName:        pulumi.StringRef(senderInvitationDisplayName),
			RecipientTenancyId: pulumi.StringRef(testTenancy.Id),
			State:              pulumi.StringRef(senderInvitationState),
			Status:             pulumi.StringRef(senderInvitationStatus),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSenderInvitations = Oci.Tenantmanagercontrolplane.GetSenderInvitations.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = senderInvitationDisplayName,
        RecipientTenancyId = testTenancy.Id,
        State = senderInvitationState,
        Status = senderInvitationStatus,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Tenantmanagercontrolplane.TenantmanagercontrolplaneFunctions;
import com.pulumi.oci.Tenantmanagercontrolplane.inputs.GetSenderInvitationsArgs;
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) {
        final var testSenderInvitations = TenantmanagercontrolplaneFunctions.getSenderInvitations(GetSenderInvitationsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(senderInvitationDisplayName)
            .recipientTenancyId(testTenancy.id())
            .state(senderInvitationState)
            .status(senderInvitationStatus)
            .build());

    }
}
Copy
variables:
  testSenderInvitations:
    fn::invoke:
      function: oci:Tenantmanagercontrolplane:getSenderInvitations
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${senderInvitationDisplayName}
        recipientTenancyId: ${testTenancy.id}
        state: ${senderInvitationState}
        status: ${senderInvitationStatus}
Copy

Using getSenderInvitations

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 getSenderInvitations(args: GetSenderInvitationsArgs, opts?: InvokeOptions): Promise<GetSenderInvitationsResult>
function getSenderInvitationsOutput(args: GetSenderInvitationsOutputArgs, opts?: InvokeOptions): Output<GetSenderInvitationsResult>
Copy
def get_sender_invitations(compartment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[_tenantmanagercontrolplane.GetSenderInvitationsFilter]] = None,
                           recipient_tenancy_id: Optional[str] = None,
                           state: Optional[str] = None,
                           status: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSenderInvitationsResult
def get_sender_invitations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_tenantmanagercontrolplane.GetSenderInvitationsFilterArgs]]]] = None,
                           recipient_tenancy_id: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSenderInvitationsResult]
Copy
func GetSenderInvitations(ctx *Context, args *GetSenderInvitationsArgs, opts ...InvokeOption) (*GetSenderInvitationsResult, error)
func GetSenderInvitationsOutput(ctx *Context, args *GetSenderInvitationsOutputArgs, opts ...InvokeOption) GetSenderInvitationsResultOutput
Copy

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

public static class GetSenderInvitations 
{
    public static Task<GetSenderInvitationsResult> InvokeAsync(GetSenderInvitationsArgs args, InvokeOptions? opts = null)
    public static Output<GetSenderInvitationsResult> Invoke(GetSenderInvitationsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSenderInvitationsResult> getSenderInvitations(GetSenderInvitationsArgs args, InvokeOptions options)
public static Output<GetSenderInvitationsResult> getSenderInvitations(GetSenderInvitationsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Tenantmanagercontrolplane/getSenderInvitations:getSenderInvitations
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetSenderInvitationsFilter>
RecipientTenancyId string
The tenancy that the invitation is addressed to.
State string
The lifecycle state of the resource.
Status string
The status of the sender invitation.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetSenderInvitationsFilter
RecipientTenancyId string
The tenancy that the invitation is addressed to.
State string
The lifecycle state of the resource.
Status string
The status of the sender invitation.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetSenderInvitationsFilter>
recipientTenancyId String
The tenancy that the invitation is addressed to.
state String
The lifecycle state of the resource.
status String
The status of the sender invitation.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetSenderInvitationsFilter[]
recipientTenancyId string
The tenancy that the invitation is addressed to.
state string
The lifecycle state of the resource.
status string
The status of the sender invitation.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
display_name str
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. Sequence[tenantmanagercontrolplane.GetSenderInvitationsFilter]
recipient_tenancy_id str
The tenancy that the invitation is addressed to.
state str
The lifecycle state of the resource.
status str
The status of the sender invitation.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>
recipientTenancyId String
The tenancy that the invitation is addressed to.
state String
The lifecycle state of the resource.
status String
The status of the sender invitation.

getSenderInvitations Result

The following output properties are available:

CompartmentId string
OCID of the sender tenancy.
Id string
The provider-assigned unique ID for this managed resource.
SenderInvitationCollections List<GetSenderInvitationsSenderInvitationCollection>
The list of sender_invitation_collection.
DisplayName string
A user-created name to describe the invitation. Avoid entering confidential information.
Filters List<GetSenderInvitationsFilter>
RecipientTenancyId string
OCID of the recipient tenancy.
State string
Lifecycle state of the sender invitation.
Status string
Status of the sender invitation.
CompartmentId string
OCID of the sender tenancy.
Id string
The provider-assigned unique ID for this managed resource.
SenderInvitationCollections []GetSenderInvitationsSenderInvitationCollection
The list of sender_invitation_collection.
DisplayName string
A user-created name to describe the invitation. Avoid entering confidential information.
Filters []GetSenderInvitationsFilter
RecipientTenancyId string
OCID of the recipient tenancy.
State string
Lifecycle state of the sender invitation.
Status string
Status of the sender invitation.
compartmentId String
OCID of the sender tenancy.
id String
The provider-assigned unique ID for this managed resource.
senderInvitationCollections List<GetSenderInvitationsSenderInvitationCollection>
The list of sender_invitation_collection.
displayName String
A user-created name to describe the invitation. Avoid entering confidential information.
filters List<GetSenderInvitationsFilter>
recipientTenancyId String
OCID of the recipient tenancy.
state String
Lifecycle state of the sender invitation.
status String
Status of the sender invitation.
compartmentId string
OCID of the sender tenancy.
id string
The provider-assigned unique ID for this managed resource.
senderInvitationCollections GetSenderInvitationsSenderInvitationCollection[]
The list of sender_invitation_collection.
displayName string
A user-created name to describe the invitation. Avoid entering confidential information.
filters GetSenderInvitationsFilter[]
recipientTenancyId string
OCID of the recipient tenancy.
state string
Lifecycle state of the sender invitation.
status string
Status of the sender invitation.
compartment_id str
OCID of the sender tenancy.
id str
The provider-assigned unique ID for this managed resource.
sender_invitation_collections Sequence[tenantmanagercontrolplane.GetSenderInvitationsSenderInvitationCollection]
The list of sender_invitation_collection.
display_name str
A user-created name to describe the invitation. Avoid entering confidential information.
filters Sequence[tenantmanagercontrolplane.GetSenderInvitationsFilter]
recipient_tenancy_id str
OCID of the recipient tenancy.
state str
Lifecycle state of the sender invitation.
status str
Status of the sender invitation.
compartmentId String
OCID of the sender tenancy.
id String
The provider-assigned unique ID for this managed resource.
senderInvitationCollections List<Property Map>
The list of sender_invitation_collection.
displayName String
A user-created name to describe the invitation. Avoid entering confidential information.
filters List<Property Map>
recipientTenancyId String
OCID of the recipient tenancy.
state String
Lifecycle state of the sender invitation.
status String
Status of the sender invitation.

Supporting Types

GetSenderInvitationsFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetSenderInvitationsSenderInvitationCollection

items This property is required. List<Property Map>

GetSenderInvitationsSenderInvitationCollectionItem

CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
OCID of the sender invitation.
RecipientEmailAddress This property is required. string
Email address of the recipient.
RecipientInvitationId This property is required. string
OCID of the corresponding recipient invitation.
RecipientTenancyId This property is required. string
The tenancy that the invitation is addressed to.
State This property is required. string
The lifecycle state of the resource.
Status This property is required. string
The status of the sender invitation.
Subjects This property is required. List<string>
The list of subjects the invitation contains.
SystemTags This property is required. Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
Date and time when the sender invitation was created.
TimeUpdated This property is required. string
Date and time when the sender invitation was last updated.
CompartmentId This property is required. string
The ID of the compartment in which to list resources.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
OCID of the sender invitation.
RecipientEmailAddress This property is required. string
Email address of the recipient.
RecipientInvitationId This property is required. string
OCID of the corresponding recipient invitation.
RecipientTenancyId This property is required. string
The tenancy that the invitation is addressed to.
State This property is required. string
The lifecycle state of the resource.
Status This property is required. string
The status of the sender invitation.
Subjects This property is required. []string
The list of subjects the invitation contains.
SystemTags This property is required. map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated This property is required. string
Date and time when the sender invitation was created.
TimeUpdated This property is required. string
Date and time when the sender invitation was last updated.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
OCID of the sender invitation.
recipientEmailAddress This property is required. String
Email address of the recipient.
recipientInvitationId This property is required. String
OCID of the corresponding recipient invitation.
recipientTenancyId This property is required. String
The tenancy that the invitation is addressed to.
state This property is required. String
The lifecycle state of the resource.
status This property is required. String
The status of the sender invitation.
subjects This property is required. List<String>
The list of subjects the invitation contains.
systemTags This property is required. Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
Date and time when the sender invitation was created.
timeUpdated This property is required. String
Date and time when the sender invitation was last updated.
compartmentId This property is required. string
The ID of the compartment in which to list resources.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
A filter to return only resources that match the entire display name given.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. string
OCID of the sender invitation.
recipientEmailAddress This property is required. string
Email address of the recipient.
recipientInvitationId This property is required. string
OCID of the corresponding recipient invitation.
recipientTenancyId This property is required. string
The tenancy that the invitation is addressed to.
state This property is required. string
The lifecycle state of the resource.
status This property is required. string
The status of the sender invitation.
subjects This property is required. string[]
The list of subjects the invitation contains.
systemTags This property is required. {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. string
Date and time when the sender invitation was created.
timeUpdated This property is required. string
Date and time when the sender invitation was last updated.
compartment_id This property is required. str
The ID of the compartment in which to list resources.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name This property is required. str
A filter to return only resources that match the entire display name given.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
OCID of the sender invitation.
recipient_email_address This property is required. str
Email address of the recipient.
recipient_invitation_id This property is required. str
OCID of the corresponding recipient invitation.
recipient_tenancy_id This property is required. str
The tenancy that the invitation is addressed to.
state This property is required. str
The lifecycle state of the resource.
status This property is required. str
The status of the sender invitation.
subjects This property is required. Sequence[str]
The list of subjects the invitation contains.
system_tags This property is required. Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created This property is required. str
Date and time when the sender invitation was created.
time_updated This property is required. str
Date and time when the sender invitation was last updated.
compartmentId This property is required. String
The ID of the compartment in which to list resources.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only resources that match the entire display name given.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
OCID of the sender invitation.
recipientEmailAddress This property is required. String
Email address of the recipient.
recipientInvitationId This property is required. String
OCID of the corresponding recipient invitation.
recipientTenancyId This property is required. String
The tenancy that the invitation is addressed to.
state This property is required. String
The lifecycle state of the resource.
status This property is required. String
The status of the sender invitation.
subjects This property is required. List<String>
The list of subjects the invitation contains.
systemTags This property is required. Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated This property is required. String
Date and time when the sender invitation was created.
timeUpdated This property is required. String
Date and time when the sender invitation was last updated.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi