Organization

class oci.tenant_manager_control_plane.models.Organization(**kwargs)

Bases: object

An organization entity.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Organization.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Organization.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Organization.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Organization.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Organization.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Organization.
compartment_id [Required] Gets the compartment_id of this Organization.
default_ucm_subscription_id [Required] Gets the default_ucm_subscription_id of this Organization.
display_name Gets the display_name of this Organization.
id [Required] Gets the id of this Organization.
lifecycle_state [Required] Gets the lifecycle_state of this Organization.
parent_name Gets the parent_name of this Organization.
time_created [Required] Gets the time_created of this Organization.
time_updated Gets the time_updated of this Organization.

Methods

__init__(**kwargs) Initializes a new Organization object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Organization. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • id (str) – The value to assign to the id property of this Organization.
  • display_name (str) – The value to assign to the display_name property of this Organization.
  • compartment_id (str) – The value to assign to the compartment_id property of this Organization.
  • parent_name (str) – The value to assign to the parent_name property of this Organization.
  • default_ucm_subscription_id (str) – The value to assign to the default_ucm_subscription_id property of this Organization.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Organization. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • time_created (datetime) – The value to assign to the time_created property of this Organization.
  • time_updated (datetime) – The value to assign to the time_updated property of this Organization.
compartment_id

[Required] Gets the compartment_id of this Organization. OCID of the compartment containing the organization. Always a tenancy OCID.

Returns:The compartment_id of this Organization.
Return type:str
default_ucm_subscription_id

[Required] Gets the default_ucm_subscription_id of this Organization. OCID of the default Annual Universal Credits subscription. Any tenancy joining the organization will automatically get assigned this subscription if a subscription is not explictly assigned.

Returns:The default_ucm_subscription_id of this Organization.
Return type:str
display_name

Gets the display_name of this Organization. A display name for the organization. Avoid entering confidential information.

Returns:The display_name of this Organization.
Return type:str
id

[Required] Gets the id of this Organization. OCID of the organization.

Returns:The id of this Organization.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this Organization. Lifecycle state of the organization.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Organization.
Return type:str
parent_name

Gets the parent_name of this Organization. The name of the tenancy that is the organization parent.

Returns:The parent_name of this Organization.
Return type:str
time_created

[Required] Gets the time_created of this Organization. Date-time when this organization was created.

Returns:The time_created of this Organization.
Return type:datetime
time_updated

Gets the time_updated of this Organization. Date-time when this organization was last updated.

Returns:The time_updated of this Organization.
Return type:datetime