CreateDomainDetails

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

Bases: object

(For tenancies that support identity domains) Details for creating an identity domain.

Methods:

__init__(**kwargs)

Initializes a new CreateDomainDetails object with values from keyword arguments.

Attributes:

admin_email

Gets the admin_email of this CreateDomainDetails.

admin_first_name

Gets the admin_first_name of this CreateDomainDetails.

admin_last_name

Gets the admin_last_name of this CreateDomainDetails.

admin_user_name

Gets the admin_user_name of this CreateDomainDetails.

compartment_id

[Required] Gets the compartment_id of this CreateDomainDetails.

defined_tags

Gets the defined_tags of this CreateDomainDetails.

description

[Required] Gets the description of this CreateDomainDetails.

display_name

[Required] Gets the display_name of this CreateDomainDetails.

freeform_tags

Gets the freeform_tags of this CreateDomainDetails.

home_region

[Required] Gets the home_region of this CreateDomainDetails.

is_hidden_on_login

Gets the is_hidden_on_login of this CreateDomainDetails.

is_notification_bypassed

Gets the is_notification_bypassed of this CreateDomainDetails.

is_primary_email_required

Gets the is_primary_email_required of this CreateDomainDetails.

license_type

[Required] Gets the license_type of this CreateDomainDetails.

__init__(**kwargs)

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

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

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

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

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

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

  • admin_first_name (str) – The value to assign to the admin_first_name property of this CreateDomainDetails.

  • admin_last_name (str) – The value to assign to the admin_last_name property of this CreateDomainDetails.

  • admin_user_name (str) – The value to assign to the admin_user_name property of this CreateDomainDetails.

  • admin_email (str) – The value to assign to the admin_email property of this CreateDomainDetails.

  • is_notification_bypassed (bool) – The value to assign to the is_notification_bypassed property of this CreateDomainDetails.

  • is_primary_email_required (bool) – The value to assign to the is_primary_email_required property of this CreateDomainDetails.

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

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

property admin_email

Gets the admin_email of this CreateDomainDetails. The administrator’s email address.

Returns

The admin_email of this CreateDomainDetails.

Return type

str

property admin_first_name

Gets the admin_first_name of this CreateDomainDetails. The administrator’s first name.

Returns

The admin_first_name of this CreateDomainDetails.

Return type

str

property admin_last_name

Gets the admin_last_name of this CreateDomainDetails. The administrator’s last name.

Returns

The admin_last_name of this CreateDomainDetails.

Return type

str

property admin_user_name

Gets the admin_user_name of this CreateDomainDetails. The administrator’s user name.

Returns

The admin_user_name of this CreateDomainDetails.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CreateDomainDetails. The OCID of the compartment where the identity domain is created.

Returns

The compartment_id of this CreateDomainDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDomainDetails. 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 CreateDomainDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this CreateDomainDetails.

Return type

str

property display_name

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

Returns

The display_name of this CreateDomainDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDomainDetails. 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 CreateDomainDetails.

Return type

dict(str, str)

property home_region

[Required] Gets the home_region of this CreateDomainDetails. The region’s name identifier. See Regions and Availability Domains for the full list of supported region names.

Example: us-phoenix-1

Returns

The home_region of this CreateDomainDetails.

Return type

str

property is_hidden_on_login

Gets the is_hidden_on_login of this CreateDomainDetails. Indicates whether the identity domain is hidden on the sign-in screen or not.

Returns

The is_hidden_on_login of this CreateDomainDetails.

Return type

bool

property is_notification_bypassed

Gets the is_notification_bypassed of this CreateDomainDetails. Indicates whether or not the administrator user created in the IDCS stripe would like to receive notifications like a welcome email. This field is required only if admin information is provided. This field is otherwise optional.

Returns

The is_notification_bypassed of this CreateDomainDetails.

Return type

bool

property is_primary_email_required

Gets the is_primary_email_required of this CreateDomainDetails. Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true.

Returns

The is_primary_email_required of this CreateDomainDetails.

Return type

bool

property license_type

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

Returns

The license_type of this CreateDomainDetails.

Return type

str