DomainSummary

class oci.identity.models.DomainSummary(**kwargs)

Bases: object

(For tenancies that support identity domains) As the name suggests, a DomainSummary object contains information about a Domain.

Attributes:

LIFECYCLE_DETAILS_ACTIVATING

A constant which can be used with the lifecycle_details property of a DomainSummary.

LIFECYCLE_DETAILS_DEACTIVATING

A constant which can be used with the lifecycle_details property of a DomainSummary.

LIFECYCLE_DETAILS_UPDATING

A constant which can be used with the lifecycle_details property of a DomainSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DomainSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DomainSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DomainSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DomainSummary.

TYPE_DEFAULT

A constant which can be used with the type property of a DomainSummary.

TYPE_SECONDARY

A constant which can be used with the type property of a DomainSummary.

compartment_id

[Required] Gets the compartment_id of this DomainSummary.

defined_tags

Gets the defined_tags of this DomainSummary.

description

[Required] Gets the description of this DomainSummary.

display_name

[Required] Gets the display_name of this DomainSummary.

freeform_tags

Gets the freeform_tags of this DomainSummary.

home_region

[Required] Gets the home_region of this DomainSummary.

home_region_url

[Required] Gets the home_region_url of this DomainSummary.

id

[Required] Gets the id of this DomainSummary.

is_hidden_on_login

[Required] Gets the is_hidden_on_login of this DomainSummary.

license_type

[Required] Gets the license_type of this DomainSummary.

lifecycle_details

Gets the lifecycle_details of this DomainSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this DomainSummary.

replica_regions

[Required] Gets the replica_regions of this DomainSummary.

time_created

[Required] Gets the time_created of this DomainSummary.

type

[Required] Gets the type of this DomainSummary.

url

[Required] Gets the url of this DomainSummary.

Methods:

__init__(**kwargs)

Initializes a new DomainSummary object with values from keyword arguments.

LIFECYCLE_DETAILS_ACTIVATING = 'ACTIVATING'

A constant which can be used with the lifecycle_details property of a DomainSummary. This constant has a value of “ACTIVATING”

LIFECYCLE_DETAILS_DEACTIVATING = 'DEACTIVATING'

A constant which can be used with the lifecycle_details property of a DomainSummary. This constant has a value of “DEACTIVATING”

LIFECYCLE_DETAILS_UPDATING = 'UPDATING'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

TYPE_DEFAULT = 'DEFAULT'

A constant which can be used with the type property of a DomainSummary. This constant has a value of “DEFAULT”

TYPE_SECONDARY = 'SECONDARY'

A constant which can be used with the type property of a DomainSummary. This constant has a value of “SECONDARY”

__init__(**kwargs)

Initializes a new DomainSummary 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 DomainSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this DomainSummary.

  • display_name (str) – The value to assign to the display_name property of this DomainSummary.

  • description (str) – The value to assign to the description property of this DomainSummary.

  • url (str) – The value to assign to the url property of this DomainSummary.

  • home_region_url (str) – The value to assign to the home_region_url property of this DomainSummary.

  • home_region (str) – The value to assign to the home_region property of this DomainSummary.

  • replica_regions (list[oci.identity.models.ReplicatedRegionDetails]) – The value to assign to the replica_regions property of this DomainSummary.

  • type (str) – The value to assign to the type property of this DomainSummary. Allowed values for this property are: “DEFAULT”, “SECONDARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • license_type (str) – The value to assign to the license_type property of this DomainSummary.

  • is_hidden_on_login (bool) – The value to assign to the is_hidden_on_login property of this DomainSummary.

  • time_created (datetime) – The value to assign to the time_created property of this DomainSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DomainSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this DomainSummary. Allowed values for this property are: “DEACTIVATING”, “ACTIVATING”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DomainSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DomainSummary.

property compartment_id

[Required] Gets the compartment_id of this DomainSummary. The OCID of the compartment containing the identity domain.

Returns

The compartment_id of this DomainSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DomainSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this DomainSummary.

Return type

dict(str, dict(str, object))

property description

[Required] Gets the description of this DomainSummary. The identity domain description. You can have an empty description.

Returns

The description of this DomainSummary.

Return type

str

property display_name

[Required] Gets the display_name of this DomainSummary. The mutable display name of the identity domain.

Returns

The display_name of this DomainSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DomainSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this DomainSummary.

Return type

dict(str, str)

property home_region

[Required] Gets the home_region of this DomainSummary. The home region for the identity domain.

Returns

The home_region of this DomainSummary.

Return type

str

property home_region_url

[Required] Gets the home_region_url of this DomainSummary. Region-specific identity domain URL.

Returns

The home_region_url of this DomainSummary.

Return type

str

property id

[Required] Gets the id of this DomainSummary. The OCID of the identity domain.

Returns

The id of this DomainSummary.

Return type

str

property is_hidden_on_login

[Required] Gets the is_hidden_on_login of this DomainSummary. Indicates whether the identity domain is hidden on the sign-in screen or not.

Returns

The is_hidden_on_login of this DomainSummary.

Return type

bool

property license_type

[Required] Gets the license_type of this DomainSummary. The license type of the identity domain.

Returns

The license_type of this DomainSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this DomainSummary. Any additional details about the current state of the identity domain.

Allowed values for this property are: “DEACTIVATING”, “ACTIVATING”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_details of this DomainSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DomainSummary. The current state.

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

Returns

The lifecycle_state of this DomainSummary.

Return type

str

property replica_regions

[Required] Gets the replica_regions of this DomainSummary. The regions where replicas of the identity domain exist.

Returns

The replica_regions of this DomainSummary.

Return type

list[oci.identity.models.ReplicatedRegionDetails]

property time_created

[Required] Gets the time_created of this DomainSummary. Date and time the identity domain was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this DomainSummary.

Return type

datetime

property type

[Required] Gets the type of this DomainSummary. The type of the identity domain.

Allowed values for this property are: “DEFAULT”, “SECONDARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this DomainSummary.

Return type

str

property url

[Required] Gets the url of this DomainSummary. Region-agnostic identity domain URL.

Returns

The url of this DomainSummary.

Return type

str