oracle / oracle.oci / 4.32.0 / module / oci_identity_domain Manage a Domain resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_domain (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
This module allows the user to create, update and delete a Domain resource in Oracle Cloud Infrastructure
For I(state=present), (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in `homeRegion`. After you send your request, the temporary `lifecycleState` of this identity domain is set to CREATING and `lifecycleDetails` to UPDATING. When creation of the identity domain completes, this identity domain's `lifecycleState` is set to ACTIVE and `lifecycleDetails` to null.
To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.
After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it.
This resource has the following action operations in the M(oracle.oci.oci_identity_domain_actions) module: activate, change_compartment, change_domain_license_type, deactivate, enable_replication_to_region.
- name: Create domain oci_identity_domain: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" home_region: us-phoenix-1 license_type: license_type_example description: description_example display_name: display_name_example # optional admin_first_name: admin_first_name_example admin_last_name: admin_last_name_example admin_user_name: admin_user_name_example admin_email: admin_email_example is_notification_bypassed: true is_primary_email_required: true is_hidden_on_login: true freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update domain oci_identity_domain: # required domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx" # optional description: description_example display_name: display_name_example is_hidden_on_login: true freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update domain using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_domain: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example # optional description: description_example is_hidden_on_login: true freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete domain oci_identity_domain: # required domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete domain using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_domain: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example state: absent
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the Domain. - Use I(state=present) to create or update a Domain. - Use I(state=absent) to delete a Domain. required: false type: str key_by: description: The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource. elements: str type: list region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str domain_id: aliases: - id description: - The OCID of the identity domain. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str admin_email: description: - The administrator's email address. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str description: description: - The identity domain description. You can have an empty description. - Required for create using I(state=present). - This parameter is updatable. type: str home_region: description: - The region's name identifier. See L(Regions and Availability Domains,https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full list of supported region names. - 'Example: `us-phoenix-1`' - Required for create using I(state=present). type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict display_name: aliases: - name description: - The mutable display name of the identity domain. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str force_create: default: false description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with I(key_by). type: bool license_type: description: - The license type of the identity domain. - Required for create using I(state=present). type: str wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: description: - '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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The OCID of the compartment where the identity domain is created. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str admin_last_name: description: - The administrator's last name. type: str admin_user_name: description: - The administrator's user name. type: str admin_first_name: description: - The administrator's first name. type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str is_hidden_on_login: description: - Indicates whether the identity domain is hidden on the sign-in screen or not. - This parameter is updatable. type: bool config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str is_notification_bypassed: description: - 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. type: bool is_primary_email_required: description: - Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true. type: bool realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
domain: contains: compartment_id: description: - The OCID of the compartment containing the identity domain. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - The identity domain description. You can have an empty description. returned: on success sample: description_example type: str display_name: description: - The mutable display name of the identity domain. returned: on success sample: display_name_example type: str freeform_tags: description: - '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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict home_region: description: - The home region for the identity domain. See L(Regions and Availability Domains,https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full list of supported region names. - 'Example: `us-phoenix-1`' returned: on success sample: us-phoenix-1 type: str home_region_url: description: - Region-specific identity domain URL. returned: on success sample: home_region_url_example type: str id: description: - The OCID of the identity domain. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_hidden_on_login: description: - Indicates whether the identity domain is hidden on the sign-in screen or not. returned: on success sample: true type: bool license_type: description: - The license type of the identity domain. returned: on success sample: license_type_example type: str lifecycle_details: description: - Any additional details about the current state of the identity domain. returned: on success sample: DEACTIVATING type: str lifecycle_state: description: - The current state. returned: on success sample: CREATING type: str replica_regions: contains: region: description: - A REPLICATION_ENABLED region, e.g. us-ashburn-1. See L(Regions and Availability Domains,https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for the full list of supported region names. returned: on success sample: us-phoenix-1 type: str state: description: - The IDCS-replicated region state. returned: on success sample: ENABLING_REPLICATION type: str url: description: - Region-agnostic identity domain URL. returned: on success sample: url_example type: str description: - The regions where replicas of the identity domain exist. returned: on success type: complex time_created: description: - Date and time the identity domain was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - The type of the domain. returned: on success sample: DEFAULT type: str url: description: - Region-agnostic identity domain URL. returned: on success sample: url_example type: str description: - Details of the Domain resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US description: description_example display_name: display_name_example freeform_tags: Department: Finance home_region: us-phoenix-1 home_region_url: home_region_url_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_hidden_on_login: true license_type: license_type_example lifecycle_details: DEACTIVATING lifecycle_state: CREATING replica_regions: - region: us-phoenix-1 state: ENABLING_REPLICATION url: url_example time_created: '2013-10-20T19:20:30+01:00' type: DEFAULT url: url_example type: complex