Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
oci.Identity.getDomains
Start a Neo task
Explain and create an oci.Identity.getDomains resource
This data source provides the list of Domains in Oracle Cloud Infrastructure Identity service.
List all domains that are homed or have a replica region in current region.
- If any internal error occurs, return 500 INTERNAL SERVER ERROR.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDomains = oci.Identity.getDomains({
compartmentId: compartmentId,
displayName: domainDisplayName,
homeRegionUrl: domainHomeRegionUrl,
isHiddenOnLogin: domainIsHiddenOnLogin,
licenseType: domainLicenseType,
name: domainName,
state: domainState,
type: domainType,
url: domainUrl,
});
import pulumi
import pulumi_oci as oci
test_domains = oci.Identity.get_domains(compartment_id=compartment_id,
display_name=domain_display_name,
home_region_url=domain_home_region_url,
is_hidden_on_login=domain_is_hidden_on_login,
license_type=domain_license_type,
name=domain_name,
state=domain_state,
type=domain_type,
url=domain_url)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/identity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identity.GetDomains(ctx, &identity.GetDomainsArgs{
CompartmentId: compartmentId,
DisplayName: pulumi.StringRef(domainDisplayName),
HomeRegionUrl: pulumi.StringRef(domainHomeRegionUrl),
IsHiddenOnLogin: pulumi.BoolRef(domainIsHiddenOnLogin),
LicenseType: pulumi.StringRef(domainLicenseType),
Name: pulumi.StringRef(domainName),
State: pulumi.StringRef(domainState),
Type: pulumi.StringRef(domainType),
Url: pulumi.StringRef(domainUrl),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDomains = Oci.Identity.GetDomains.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = domainDisplayName,
HomeRegionUrl = domainHomeRegionUrl,
IsHiddenOnLogin = domainIsHiddenOnLogin,
LicenseType = domainLicenseType,
Name = domainName,
State = domainState,
Type = domainType,
Url = domainUrl,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetDomainsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testDomains = IdentityFunctions.getDomains(GetDomainsArgs.builder()
.compartmentId(compartmentId)
.displayName(domainDisplayName)
.homeRegionUrl(domainHomeRegionUrl)
.isHiddenOnLogin(domainIsHiddenOnLogin)
.licenseType(domainLicenseType)
.name(domainName)
.state(domainState)
.type(domainType)
.url(domainUrl)
.build());
}
}
variables:
testDomains:
fn::invoke:
function: oci:Identity:getDomains
arguments:
compartmentId: ${compartmentId}
displayName: ${domainDisplayName}
homeRegionUrl: ${domainHomeRegionUrl}
isHiddenOnLogin: ${domainIsHiddenOnLogin}
licenseType: ${domainLicenseType}
name: ${domainName}
state: ${domainState}
type: ${domainType}
url: ${domainUrl}
Using getDomains
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function getDomainsOutput(args: GetDomainsOutputArgs, opts?: InvokeOptions): Output<GetDomainsResult>def get_domains(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[GetDomainsFilter]] = None,
home_region_url: Optional[str] = None,
is_hidden_on_login: Optional[bool] = None,
license_type: Optional[str] = None,
name: Optional[str] = None,
state: Optional[str] = None,
type: Optional[str] = None,
url: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainsFilterArgs]]]] = None,
home_region_url: Optional[pulumi.Input[str]] = None,
is_hidden_on_login: Optional[pulumi.Input[bool]] = None,
license_type: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
type: Optional[pulumi.Input[str]] = None,
url: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDomainsResult]func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
func GetDomainsOutput(ctx *Context, args *GetDomainsOutputArgs, opts ...InvokeOption) GetDomainsResultOutput> Note: This function is named GetDomains in the Go SDK.
public static class GetDomains
{
public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
public static Output<GetDomainsResult> Invoke(GetDomainsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
public static Output<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Identity/getDomains:getDomains
arguments:
# arguments dictionaryThe following arguments are supported:
- Compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Display
Name string - The mutable display name of the domain
- Filters
List<Get
Domains Filter> - Home
Region stringUrl - The region specific domain URL
- bool
- Indicate if the domain is visible at login screen or not
- License
Type string - The domain license type
- Name string
- A filter to only return resources that match the given name exactly.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Type string
- The domain type
- Url string
- The region agnostic domain URL
- Compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Display
Name string - The mutable display name of the domain
- Filters
[]Get
Domains Filter - Home
Region stringUrl - The region specific domain URL
- bool
- Indicate if the domain is visible at login screen or not
- License
Type string - The domain license type
- Name string
- A filter to only return resources that match the given name exactly.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Type string
- The domain type
- Url string
- The region agnostic domain URL
- compartment
Id String - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- display
Name String - The mutable display name of the domain
- filters
List<Get
Domains Filter> - home
Region StringUrl - The region specific domain URL
- Boolean
- Indicate if the domain is visible at login screen or not
- license
Type String - The domain license type
- name String
- A filter to only return resources that match the given name exactly.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- type String
- The domain type
- url String
- The region agnostic domain URL
- compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- display
Name string - The mutable display name of the domain
- filters
Get
Domains Filter[] - home
Region stringUrl - The region specific domain URL
- boolean
- Indicate if the domain is visible at login screen or not
- license
Type string - The domain license type
- name string
- A filter to only return resources that match the given name exactly.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- type string
- The domain type
- url string
- The region agnostic domain URL
- compartment_
id str - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- display_
name str - The mutable display name of the domain
- filters
Sequence[Get
Domains Filter] - home_
region_ strurl - The region specific domain URL
- bool
- Indicate if the domain is visible at login screen or not
- license_
type str - The domain license type
- name str
- A filter to only return resources that match the given name exactly.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- type str
- The domain type
- url str
- The region agnostic domain URL
- compartment
Id String - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- display
Name String - The mutable display name of the domain
- filters List<Property Map>
- home
Region StringUrl - The region specific domain URL
- Boolean
- Indicate if the domain is visible at login screen or not
- license
Type String - The domain license type
- name String
- A filter to only return resources that match the given name exactly.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- type String
- The domain type
- url String
- The region agnostic domain URL
getDomains Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment containing the domain.
- Domains
List<Get
Domains Domain> - The list of domains.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - The mutable display name of the domain
- Filters
List<Get
Domains Filter> - Home
Region stringUrl - Region specific domain URL.
- bool
- Indicates whether domain is hidden on login screen or not.
- License
Type string - The License type of Domain
- Name string
- State string
- The current state.
- Type string
- The type of the domain.
- Url string
- Region agnostic domain URL.
- Compartment
Id string - The OCID of the compartment containing the domain.
- Domains
[]Get
Domains Domain - The list of domains.
- Id string
- The provider-assigned unique ID for this managed resource.
- Display
Name string - The mutable display name of the domain
- Filters
[]Get
Domains Filter - Home
Region stringUrl - Region specific domain URL.
- bool
- Indicates whether domain is hidden on login screen or not.
- License
Type string - The License type of Domain
- Name string
- State string
- The current state.
- Type string
- The type of the domain.
- Url string
- Region agnostic domain URL.
- compartment
Id String - The OCID of the compartment containing the domain.
- domains
List<Get
Domains Domain> - The list of domains.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - The mutable display name of the domain
- filters
List<Get
Domains Filter> - home
Region StringUrl - Region specific domain URL.
- Boolean
- Indicates whether domain is hidden on login screen or not.
- license
Type String - The License type of Domain
- name String
- state String
- The current state.
- type String
- The type of the domain.
- url String
- Region agnostic domain URL.
- compartment
Id string - The OCID of the compartment containing the domain.
- domains
Get
Domains Domain[] - The list of domains.
- id string
- The provider-assigned unique ID for this managed resource.
- display
Name string - The mutable display name of the domain
- filters
Get
Domains Filter[] - home
Region stringUrl - Region specific domain URL.
- boolean
- Indicates whether domain is hidden on login screen or not.
- license
Type string - The License type of Domain
- name string
- state string
- The current state.
- type string
- The type of the domain.
- url string
- Region agnostic domain URL.
- compartment_
id str - The OCID of the compartment containing the domain.
- domains
Sequence[Get
Domains Domain] - The list of domains.
- id str
- The provider-assigned unique ID for this managed resource.
- display_
name str - The mutable display name of the domain
- filters
Sequence[Get
Domains Filter] - home_
region_ strurl - Region specific domain URL.
- bool
- Indicates whether domain is hidden on login screen or not.
- license_
type str - The License type of Domain
- name str
- state str
- The current state.
- type str
- The type of the domain.
- url str
- Region agnostic domain URL.
- compartment
Id String - The OCID of the compartment containing the domain.
- domains List<Property Map>
- The list of domains.
- id String
- The provider-assigned unique ID for this managed resource.
- display
Name String - The mutable display name of the domain
- filters List<Property Map>
- home
Region StringUrl - Region specific domain URL.
- Boolean
- Indicates whether domain is hidden on login screen or not.
- license
Type String - The License type of Domain
- name String
- state String
- The current state.
- type String
- The type of the domain.
- url String
- Region agnostic domain URL.
Supporting Types
GetDomainsDomain
- Admin
Email string - Admin
First stringName - Admin
Last stringName - Admin
User stringName - Compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- The domain descripition
- Display
Name string - The mutable display name of the domain
- Dictionary<string, string>
- 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"} - Home
Region string - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - Home
Region stringUrl - The region specific domain URL
- Id string
- The OCID of the domain
- bool
- Indicate if the domain is visible at login screen or not
- Is
Notification boolBypassed - Is
Primary boolEmail Required - License
Type string - The domain license type
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions List<GetDomains Domain Replica Region> - The regions domain is replication to.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Time
Created string - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Type string
- The domain type
- Url string
- The region agnostic domain URL
- Admin
Email string - Admin
First stringName - Admin
Last stringName - Admin
User stringName - Compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - Description string
- The domain descripition
- Display
Name string - The mutable display name of the domain
- map[string]string
- 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"} - Home
Region string - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - Home
Region stringUrl - The region specific domain URL
- Id string
- The OCID of the domain
- bool
- Indicate if the domain is visible at login screen or not
- Is
Notification boolBypassed - Is
Primary boolEmail Required - License
Type string - The domain license type
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions []GetDomains Domain Replica Region - The regions domain is replication to.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Time
Created string - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - Type string
- The domain type
- Url string
- The region agnostic domain URL
- admin
Email String - admin
First StringName - admin
Last StringName - admin
User StringName - compartment
Id String - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- The domain descripition
- display
Name String - The mutable display name of the domain
- Map<String,String>
- 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"} - home
Region String - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - home
Region StringUrl - The region specific domain URL
- id String
- The OCID of the domain
- Boolean
- Indicate if the domain is visible at login screen or not
- is
Notification BooleanBypassed - is
Primary BooleanEmail Required - license
Type String - The domain license type
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<GetDomains Domain Replica Region> - The regions domain is replication to.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created String - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - type String
- The domain type
- url String
- The region agnostic domain URL
- admin
Email string - admin
First stringName - admin
Last stringName - admin
User stringName - compartment
Id string - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description string
- The domain descripition
- display
Name string - The mutable display name of the domain
- {[key: string]: string}
- 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"} - home
Region string - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - home
Region stringUrl - The region specific domain URL
- id string
- The OCID of the domain
- boolean
- Indicate if the domain is visible at login screen or not
- is
Notification booleanBypassed - is
Primary booleanEmail Required - license
Type string - The domain license type
- lifecycle
Details string - Any additional details about the current state of the Domain.
- replica
Regions GetDomains Domain Replica Region[] - The regions domain is replication to.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created string - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - type string
- The domain type
- url string
- The region agnostic domain URL
- admin_
email str - admin_
first_ strname - admin_
last_ strname - admin_
user_ strname - compartment_
id str - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description str
- The domain descripition
- display_
name str - The mutable display name of the domain
- Mapping[str, str]
- 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"} - home_
region str - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - home_
region_ strurl - The region specific domain URL
- id str
- The OCID of the domain
- bool
- Indicate if the domain is visible at login screen or not
- is_
notification_ boolbypassed - is_
primary_ boolemail_ required - license_
type str - The domain license type
- lifecycle_
details str - Any additional details about the current state of the Domain.
- replica_
regions Sequence[GetDomains Domain Replica Region] - The regions domain is replication to.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time_
created str - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - type str
- The domain type
- url str
- The region agnostic domain URL
- admin
Email String - admin
First StringName - admin
Last StringName - admin
User StringName - compartment
Id String - The OCID of the compartment (remember that the tenancy is simply the root compartment).
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"} - description String
- The domain descripition
- display
Name String - The mutable display name of the domain
- Map<String>
- 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"} - home
Region String - The home region for the domain. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1 - home
Region StringUrl - The region specific domain URL
- id String
- The OCID of the domain
- Boolean
- Indicate if the domain is visible at login screen or not
- is
Notification BooleanBypassed - is
Primary BooleanEmail Required - license
Type String - The domain license type
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<Property Map> - The regions domain is replication to.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- time
Created String - Date and time the domain was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z - type String
- The domain type
- url String
- The region agnostic domain URL
GetDomainsDomainReplicaRegion
- Region string
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Url string
- The region agnostic domain URL
- Region string
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Url string
- The region agnostic domain URL
- region String
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- url String
- The region agnostic domain URL
- region string
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- url string
- The region agnostic domain URL
- region str
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- url str
- The region agnostic domain URL
- region String
- A REPLICATION_ENABLED region, e.g. us-ashburn-1. See Regions and Availability Domains for the full list of supported region names.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- url String
- The region agnostic domain URL
GetDomainsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.
