Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Tenantmanagercontrolplane.getRecipientInvitations

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testRecipientInvitations = oci.Tenantmanagercontrolplane.getRecipientInvitations({
    compartmentId: compartmentId,
    senderTenancyId: testTenancy.id,
    state: recipientInvitationState,
    status: recipientInvitationStatus,
});

import pulumi
import pulumi_oci as oci

test_recipient_invitations = oci.Tenantmanagercontrolplane.get_recipient_invitations(compartment_id=compartment_id,
    sender_tenancy_id=test_tenancy["id"],
    state=recipient_invitation_state,
    status=recipient_invitation_status)

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.GetRecipientInvitations(ctx, &tenantmanagercontrolplane.GetRecipientInvitationsArgs{
			CompartmentId:   compartmentId,
			SenderTenancyId: pulumi.StringRef(testTenancy.Id),
			State:           pulumi.StringRef(recipientInvitationState),
			Status:          pulumi.StringRef(recipientInvitationStatus),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testRecipientInvitations = Oci.Tenantmanagercontrolplane.GetRecipientInvitations.Invoke(new()
    {
        CompartmentId = compartmentId,
        SenderTenancyId = testTenancy.Id,
        State = recipientInvitationState,
        Status = recipientInvitationStatus,
    });

});

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.GetRecipientInvitationsArgs;
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 testRecipientInvitations = TenantmanagercontrolplaneFunctions.getRecipientInvitations(GetRecipientInvitationsArgs.builder()
            .compartmentId(compartmentId)
            .senderTenancyId(testTenancy.id())
            .state(recipientInvitationState)
            .status(recipientInvitationStatus)
            .build());

    }
}

variables:
  testRecipientInvitations:
    fn::invoke:
      function: oci:Tenantmanagercontrolplane:getRecipientInvitations
      arguments:
        compartmentId: ${compartmentId}
        senderTenancyId: ${testTenancy.id}
        state: ${recipientInvitationState}
        status: ${recipientInvitationStatus}

Using getRecipientInvitations

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 getRecipientInvitations(args: GetRecipientInvitationsArgs, opts?: InvokeOptions): Promise<GetRecipientInvitationsResult>
function getRecipientInvitationsOutput(args: GetRecipientInvitationsOutputArgs, opts?: InvokeOptions): Output<GetRecipientInvitationsResult>

def get_recipient_invitations(compartment_id: Optional[str] = None,
                              filters: Optional[Sequence[_tenantmanagercontrolplane.GetRecipientInvitationsFilter]] = None,
                              sender_tenancy_id: Optional[str] = None,
                              state: Optional[str] = None,
                              status: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRecipientInvitationsResult
def get_recipient_invitations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                              filters: Optional[pulumi.Input[Sequence[pulumi.Input[_tenantmanagercontrolplane.GetRecipientInvitationsFilterArgs]]]] = None,
                              sender_tenancy_id: Optional[pulumi.Input[str]] = None,
                              state: Optional[pulumi.Input[str]] = None,
                              status: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetRecipientInvitationsResult]

func GetRecipientInvitations(ctx *Context, args *GetRecipientInvitationsArgs, opts ...InvokeOption) (*GetRecipientInvitationsResult, error)
func GetRecipientInvitationsOutput(ctx *Context, args *GetRecipientInvitationsOutputArgs, opts ...InvokeOption) GetRecipientInvitationsResultOutput

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

public static class GetRecipientInvitations 
{
    public static Task<GetRecipientInvitationsResult> InvokeAsync(GetRecipientInvitationsArgs args, InvokeOptions? opts = null)
    public static Output<GetRecipientInvitationsResult> Invoke(GetRecipientInvitationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRecipientInvitationsResult> getRecipientInvitations(GetRecipientInvitationsArgs args, InvokeOptions options)
public static Output<GetRecipientInvitationsResult> getRecipientInvitations(GetRecipientInvitationsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Tenantmanagercontrolplane/getRecipientInvitations:getRecipientInvitations
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
Filters List<GetRecipientInvitationsFilter>
SenderTenancyId string: The tenancy that sent the invitation.
State string: The lifecycle state of the resource.
Status string: The status of the recipient invitation.

CompartmentId string: The ID of the compartment in which to list resources.
Filters []GetRecipientInvitationsFilter
SenderTenancyId string: The tenancy that sent the invitation.
State string: The lifecycle state of the resource.
Status string: The status of the recipient invitation.

compartmentId String: The ID of the compartment in which to list resources.
filters List<GetRecipientInvitationsFilter>
senderTenancyId String: The tenancy that sent the invitation.
state String: The lifecycle state of the resource.
status String: The status of the recipient invitation.

compartmentId string: The ID of the compartment in which to list resources.
filters GetRecipientInvitationsFilter[]
senderTenancyId string: The tenancy that sent the invitation.
state string: The lifecycle state of the resource.
status string: The status of the recipient invitation.

compartment_id str: The ID of the compartment in which to list resources.
filters Sequence[tenantmanagercontrolplane.GetRecipientInvitationsFilter]
sender_tenancy_id str: The tenancy that sent the invitation.
state str: The lifecycle state of the resource.
status str: The status of the recipient invitation.

compartmentId String: The ID of the compartment in which to list resources.
filters List<Property Map>
senderTenancyId String: The tenancy that sent the invitation.
state String: The lifecycle state of the resource.
status String: The status of the recipient invitation.

getRecipientInvitations Result

The following output properties are available:

CompartmentId string: OCID of the recipient tenancy.
Id string: The provider-assigned unique ID for this managed resource.
RecipientInvitationCollections List<GetRecipientInvitationsRecipientInvitationCollection>: The list of recipient_invitation_collection.
Filters List<GetRecipientInvitationsFilter>
SenderTenancyId string: OCID of the sender tenancy.
State string: Lifecycle state of the recipient invitation.
Status string: Status of the recipient invitation.

CompartmentId string: OCID of the recipient tenancy.
Id string: The provider-assigned unique ID for this managed resource.
RecipientInvitationCollections []GetRecipientInvitationsRecipientInvitationCollection: The list of recipient_invitation_collection.
Filters []GetRecipientInvitationsFilter
SenderTenancyId string: OCID of the sender tenancy.
State string: Lifecycle state of the recipient invitation.
Status string: Status of the recipient invitation.

compartmentId String: OCID of the recipient tenancy.
id String: The provider-assigned unique ID for this managed resource.
recipientInvitationCollections List<GetRecipientInvitationsRecipientInvitationCollection>: The list of recipient_invitation_collection.
filters List<GetRecipientInvitationsFilter>
senderTenancyId String: OCID of the sender tenancy.
state String: Lifecycle state of the recipient invitation.
status String: Status of the recipient invitation.

compartmentId string: OCID of the recipient tenancy.
id string: The provider-assigned unique ID for this managed resource.
recipientInvitationCollections GetRecipientInvitationsRecipientInvitationCollection[]: The list of recipient_invitation_collection.
filters GetRecipientInvitationsFilter[]
senderTenancyId string: OCID of the sender tenancy.
state string: Lifecycle state of the recipient invitation.
status string: Status of the recipient invitation.

compartment_id str: OCID of the recipient tenancy.
id str: The provider-assigned unique ID for this managed resource.
recipient_invitation_collections Sequence[tenantmanagercontrolplane.GetRecipientInvitationsRecipientInvitationCollection]: The list of recipient_invitation_collection.
filters Sequence[tenantmanagercontrolplane.GetRecipientInvitationsFilter]
sender_tenancy_id str: OCID of the sender tenancy.
state str: Lifecycle state of the recipient invitation.
status str: Status of the recipient invitation.

compartmentId String: OCID of the recipient tenancy.
id String: The provider-assigned unique ID for this managed resource.
recipientInvitationCollections List<Property Map>: The list of recipient_invitation_collection.
filters List<Property Map>
senderTenancyId String: OCID of the sender tenancy.
state String: Lifecycle state of the recipient invitation.
status String: Status of the recipient invitation.

Supporting Types

GetRecipientInvitationsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetRecipientInvitationsRecipientInvitationCollection

Items List<GetRecipientInvitationsRecipientInvitationCollectionItem>

Items []GetRecipientInvitationsRecipientInvitationCollectionItem

items List<GetRecipientInvitationsRecipientInvitationCollectionItem>

items GetRecipientInvitationsRecipientInvitationCollectionItem[]

items Sequence[tenantmanagercontrolplane.GetRecipientInvitationsRecipientInvitationCollectionItem]

items List<Property Map>

GetRecipientInvitationsRecipientInvitationCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A user-created name to describe the invitation. Avoid entering confidential information.
FreeformTags 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 string: OCID of the recipient invitation.
RecipientEmailAddress string: Email address of the recipient.
SenderInvitationId string: OCID of the corresponding sender invitation.
SenderTenancyId string: The tenancy that sent the invitation.
State string: The lifecycle state of the resource.
Status string: The status of the recipient invitation.
Subjects List<string>: The list of subjects the invitation contains.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: Date and time when the recipient invitation was created.
TimeUpdated string: Date and time when the recipient invitation was last updated.

CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A user-created name to describe the invitation. Avoid entering confidential information.
FreeformTags 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 string: OCID of the recipient invitation.
RecipientEmailAddress string: Email address of the recipient.
SenderInvitationId string: OCID of the corresponding sender invitation.
SenderTenancyId string: The tenancy that sent the invitation.
State string: The lifecycle state of the resource.
Status string: The status of the recipient invitation.
Subjects []string: The list of subjects the invitation contains.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: Date and time when the recipient invitation was created.
TimeUpdated string: Date and time when the recipient invitation was last updated.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: A user-created name to describe the invitation. Avoid entering confidential information.
freeformTags 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 String: OCID of the recipient invitation.
recipientEmailAddress String: Email address of the recipient.
senderInvitationId String: OCID of the corresponding sender invitation.
senderTenancyId String: The tenancy that sent the invitation.
state String: The lifecycle state of the resource.
status String: The status of the recipient invitation.
subjects List<String>: The list of subjects the invitation contains.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: Date and time when the recipient invitation was created.
timeUpdated String: Date and time when the recipient invitation was last updated.

compartmentId string: The ID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: A user-created name to describe the invitation. Avoid entering confidential information.
freeformTags {[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 string: OCID of the recipient invitation.
recipientEmailAddress string: Email address of the recipient.
senderInvitationId string: OCID of the corresponding sender invitation.
senderTenancyId string: The tenancy that sent the invitation.
state string: The lifecycle state of the resource.
status string: The status of the recipient invitation.
subjects string[]: The list of subjects the invitation contains.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: Date and time when the recipient invitation was created.
timeUpdated string: Date and time when the recipient invitation was last updated.

compartment_id str: The ID of the compartment in which to list resources.
defined_tags 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 str: A user-created name to describe the invitation. Avoid entering confidential information.
freeform_tags 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 str: OCID of the recipient invitation.
recipient_email_address str: Email address of the recipient.
sender_invitation_id str: OCID of the corresponding sender invitation.
sender_tenancy_id str: The tenancy that sent the invitation.
state str: The lifecycle state of the resource.
status str: The status of the recipient invitation.
subjects Sequence[str]: The list of subjects the invitation contains.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: Date and time when the recipient invitation was created.
time_updated str: Date and time when the recipient invitation was last updated.

compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: A user-created name to describe the invitation. Avoid entering confidential information.
freeformTags 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 String: OCID of the recipient invitation.
recipientEmailAddress String: Email address of the recipient.
senderInvitationId String: OCID of the corresponding sender invitation.
senderTenancyId String: The tenancy that sent the invitation.
state String: The lifecycle state of the resource.
status String: The status of the recipient invitation.
subjects List<String>: The list of subjects the invitation contains.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: Date and time when the recipient invitation was created.
timeUpdated String: Date and time when the recipient 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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Tenantmanagercontrolplane.getRecipientInvitations

On this page

On this page

Example Usage

Using getRecipientInvitations

getRecipientInvitations Result

Supporting Types

GetRecipientInvitationsFilter

GetRecipientInvitationsRecipientInvitationCollection

GetRecipientInvitationsRecipientInvitationCollectionItem

Package Details

On this page

On this page