oracle.oci.oci_identity_domain – Manage a Domain resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_identity_domain
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Domain resource in Oracle Cloud Infrastructure
For 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 oracle.oci.oci_identity_domain_actions module: activate, change_compartment, change_domain_license_type, deactivate, enable_replication_to_region.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
admin_email
string
|
The administrator's email address.
|
|
admin_first_name
string
|
The administrator's first name.
|
|
admin_last_name
string
|
The administrator's last name.
|
|
admin_user_name
string
|
The administrator's user name.
|
|
api_user
string
|
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
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
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
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
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
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
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 config_file_location ). |
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see 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 auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
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.
|
|
compartment_id
string
|
The OCID of the compartment where the identity domain is created.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|
config_file_location
string
|
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.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
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 config_file_location . |
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|
description
string
|
The identity domain description. You can have an empty description.
Required for create using state=present.
This parameter is updatable.
|
|
display_name
string
|
The mutable display name of the identity domain.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|
domain_id
string
|
The OCID of the identity domain.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
force_create
boolean
|
|
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 key_by.
|
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
|
home_region
string
|
The region's name identifier. See Regions and Availability Domains for the full list of supported region names.
Example: `us-phoenix-1`
Required for create using state=present.
|
|
is_hidden_on_login
boolean
|
|
Indicates whether the identity domain is hidden on the sign-in screen or not.
This parameter is updatable.
|
is_notification_bypassed
boolean
|
|
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.
|
is_primary_email_required
boolean
|
|
Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true.
|
key_by
list
/ elements=string
|
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.
|
|
license_type
string
|
The license type of the identity domain.
Required for create using state=present.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
region
string
|
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
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
state
string
|
|
The state of the Domain.
Use state=present to create or update a Domain.
Use state=absent to delete a Domain.
|
tenancy
string
|
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
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
domain
complex
|
on success |
Details of the Domain resource acted upon by the current operation
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', 'regional_url': 'regional_url_example', 'state': 'ENABLING_REPLICATION', 'url': 'url_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'DEFAULT', 'url': 'url_example'}
|
||
compartment_id
string
|
on success |
The OCID of the compartment containing the identity domain.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
description
string
|
on success |
The identity domain description. You can have an empty description.
Sample:
description_example
|
||
display_name
string
|
on success |
The mutable display name of the identity domain.
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
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"}`
Sample:
{'Department': 'Finance'}
|
||
home_region
string
|
on success |
The home region for the identity domain. See Regions and Availability Domains for the full list of supported region names.
Example: `us-phoenix-1`
Sample:
us-phoenix-1
|
||
home_region_url
string
|
on success |
Region-specific identity domain URL.
Sample:
home_region_url_example
|
||
id
string
|
on success |
The OCID of the identity domain.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_hidden_on_login
boolean
|
on success |
Indicates whether the identity domain is hidden on the sign-in screen or not.
Sample:
True
|
||
license_type
string
|
on success |
The license type of the identity domain.
Sample:
license_type_example
|
||
lifecycle_details
string
|
on success |
Any additional details about the current state of the identity domain.
Sample:
DEACTIVATING
|
||
lifecycle_state
string
|
on success |
The current state.
Sample:
CREATING
|
||
replica_regions
complex
|
on success |
The regions where replicas of the identity domain exist.
|
||
region
string
|
on success |
A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
Sample:
us-phoenix-1
|
||
regional_url
string
|
on success |
Region-specific identity domain URL.
Sample:
regional_url_example
|
||
state
string
|
on success |
The IDCS-replicated region state.
Sample:
ENABLING_REPLICATION
|
||
url
string
|
on success |
Region-agnostic identity domain URL.
Sample:
url_example
|
||
time_created
string
|
on success |
Date and time the identity domain was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
type
string
|
on success |
The type of the domain.
Sample:
DEFAULT
|
||
url
string
|
on success |
Region-agnostic identity domain URL.
Sample:
url_example
|
Authors¶
Oracle (@oracle)