list

Description

Return a (paginated) list of recipient invitations.

Usage

oci organizations recipient-invitation list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The ID of the compartment in which to list resources.

Optional Parameters

--all

Fetches all pages of results.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--lifecycle-state [text]

The lifecycle state of the resource.

Accepted values are:

ACTIVE, CREATING, FAILED, INACTIVE, TERMINATED, UPDATING
--page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

--sender-tenancy-id [text]

The tenancy that sent the invitation.

--status [text]

The status of the recipient invitation.

Accepted values are:

ACCEPTED, CANCELED, EXPIRED, FAILED, IGNORED, PENDING

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/organizations/recipient-invitation/list.html#cmdoption-compartment-id

    oci organizations recipient-invitation list --compartment-id $compartment_id