CreateSenderInvitationDetails¶

class oci.tenant_manager_control_plane.models.CreateSenderInvitationDetails(**kwargs)¶

Bases: object

The parameters for creating a sender invitation.

Methods

__init__(**kwargs) Initializes a new CreateSenderInvitationDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateSenderInvitationDetails.
`defined_tags`	Gets the defined_tags of this CreateSenderInvitationDetails.
`display_name`	Gets the display_name of this CreateSenderInvitationDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSenderInvitationDetails.
`recipient_email_address`	Gets the recipient_email_address of this CreateSenderInvitationDetails.
`recipient_tenancy_id`	[Required] Gets the recipient_tenancy_id of this CreateSenderInvitationDetails.
`subjects`	Gets the subjects of this CreateSenderInvitationDetails.

__init__(**kwargs)¶

Initializes a new CreateSenderInvitationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateSenderInvitationDetails.
recipient_tenancy_id (str) – The value to assign to the recipient_tenancy_id property of this CreateSenderInvitationDetails.
recipient_email_address (str) – The value to assign to the recipient_email_address property of this CreateSenderInvitationDetails.
display_name (str) – The value to assign to the display_name property of this CreateSenderInvitationDetails.
subjects (list[oci.tenant_manager_control_plane.models.InvitationSubject]) – The value to assign to the subjects property of this CreateSenderInvitationDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSenderInvitationDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSenderInvitationDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateSenderInvitationDetails. OCID of the sender tenancy.

Returns:	The compartment_id of this CreateSenderInvitationDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateSenderInvitationDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateSenderInvitationDetails.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CreateSenderInvitationDetails. A user-created name to describe the invitation. Avoid entering confidential information.

Returns:	The display_name of this CreateSenderInvitationDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateSenderInvitationDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateSenderInvitationDetails.
Return type:	dict(str, str)

recipient_email_address¶

Gets the recipient_email_address of this CreateSenderInvitationDetails. Email address of the recipient.

Returns:	The recipient_email_address of this CreateSenderInvitationDetails.
Return type:	str

recipient_tenancy_id¶

[Required] Gets the recipient_tenancy_id of this CreateSenderInvitationDetails. OCID of the recipient tenancy.

Returns:	The recipient_tenancy_id of this CreateSenderInvitationDetails.
Return type:	str

subjects¶

Gets the subjects of this CreateSenderInvitationDetails. The list of subjects this invitation contains.

Returns:	The subjects of this CreateSenderInvitationDetails.
Return type:	list[oci.tenant_manager_control_plane.models.InvitationSubject]