oracle.oci.oci_identity_domain_facts – Fetches details about one or multiple Domain resources 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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Domain resources in Oracle Cloud Infrastructure

  • (For tenancies that support identity domains) Lists all identity domains within a tenancy.

  • If domain_id is specified, the details of a single Domain will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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 (remember that the tenancy is simply the root compartment).
Required to list multiple domains.
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.
display_name
string
The mutable display name of the identity domain.
domain_id
string
The OCID of the identity domain.
Required to get a specific domain.

aliases: id
home_region_url
string
The region-specific identity domain URL.
is_hidden_on_login
boolean
    Choices:
  • no
  • yes
Indicates whether or not the identity domain is visible at the sign-in screen.
license_type
string
The license type of the identity domain.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • INACTIVE
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
name
string
A filter to only return resources that match the given name exactly.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
sort_by
string
    Choices:
  • TIMECREATED
  • NAME
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order is case sensitive.
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
type
string
The identity domain type.
url
string
The region-agnostic identity domain URL.

Examples

- name: Get a specific domain
  oci_identity_domain_facts:
    # required
    domain_id: "ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx"

- name: List domains
  oci_identity_domain_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    url: url_example
    home_region_url: home_region_url_example
    type: type_example
    license_type: license_type_example
    is_hidden_on_login: true
    name: name_example
    sort_by: TIMECREATED
    sort_order: ASC
    lifecycle_state: CREATING

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
domains
complex
on success
List of Domain resources

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)