oci.Identity.Domain
Explore with Pulumi AI
This resource provides the Domain resource in Oracle Cloud Infrastructure Identity service.
Creates a new domain in the tenancy with domain home in {@code homeRegion}. This is an asynchronous call - where, at start, {@code lifecycleState} of this domain is set to CREATING and {@code lifecycleDetails} to UPDATING. On domain creation completion this Domain’s {@code lifecycleState} will be set to ACTIVE and {@code lifecycleDetails} to null.
To track progress, HTTP GET on /iamWorkRequests/{iamWorkRequestsId} endpoint will provide the async operation’s status.
After creating a Domain
, make sure its lifecycleState
changes from CREATING to ACTIVE
before using it.
If the domain’s {@code displayName} already exists, returns 400 BAD REQUEST.
If any one of admin related fields are provided and one of the following 3 fields
- {@code adminEmail}, {@code adminLastName} and {@code adminUserName} - is not provided, returns 400 BAD REQUEST.
- If {@code isNotificationBypassed} is NOT provided when admin information is provided, returns 400 BAD REQUEST.
- 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 testDomain = new oci.identity.Domain("test_domain", {
compartmentId: compartmentId,
description: domainDescription,
displayName: domainDisplayName,
homeRegion: domainHomeRegion,
licenseType: domainLicenseType,
adminEmail: domainAdminEmail,
adminFirstName: domainAdminFirstName,
adminLastName: domainAdminLastName,
adminUserName: testUser.name,
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
isHiddenOnLogin: domainIsHiddenOnLogin,
isNotificationBypassed: domainIsNotificationBypassed,
isPrimaryEmailRequired: domainIsPrimaryEmailRequired,
});
import pulumi
import pulumi_oci as oci
test_domain = oci.identity.Domain("test_domain",
compartment_id=compartment_id,
description=domain_description,
display_name=domain_display_name,
home_region=domain_home_region,
license_type=domain_license_type,
admin_email=domain_admin_email,
admin_first_name=domain_admin_first_name,
admin_last_name=domain_admin_last_name,
admin_user_name=test_user["name"],
defined_tags={
"Operations.CostCenter": "42",
},
freeform_tags={
"Department": "Finance",
},
is_hidden_on_login=domain_is_hidden_on_login,
is_notification_bypassed=domain_is_notification_bypassed,
is_primary_email_required=domain_is_primary_email_required)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Identity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Identity.NewDomain(ctx, "test_domain", &Identity.DomainArgs{
CompartmentId: pulumi.Any(compartmentId),
Description: pulumi.Any(domainDescription),
DisplayName: pulumi.Any(domainDisplayName),
HomeRegion: pulumi.Any(domainHomeRegion),
LicenseType: pulumi.Any(domainLicenseType),
AdminEmail: pulumi.Any(domainAdminEmail),
AdminFirstName: pulumi.Any(domainAdminFirstName),
AdminLastName: pulumi.Any(domainAdminLastName),
AdminUserName: pulumi.Any(testUser.Name),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
IsHiddenOnLogin: pulumi.Any(domainIsHiddenOnLogin),
IsNotificationBypassed: pulumi.Any(domainIsNotificationBypassed),
IsPrimaryEmailRequired: pulumi.Any(domainIsPrimaryEmailRequired),
})
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 testDomain = new Oci.Identity.Domain("test_domain", new()
{
CompartmentId = compartmentId,
Description = domainDescription,
DisplayName = domainDisplayName,
HomeRegion = domainHomeRegion,
LicenseType = domainLicenseType,
AdminEmail = domainAdminEmail,
AdminFirstName = domainAdminFirstName,
AdminLastName = domainAdminLastName,
AdminUserName = testUser.Name,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
IsHiddenOnLogin = domainIsHiddenOnLogin,
IsNotificationBypassed = domainIsNotificationBypassed,
IsPrimaryEmailRequired = domainIsPrimaryEmailRequired,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.Domain;
import com.pulumi.oci.Identity.DomainArgs;
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) {
var testDomain = new Domain("testDomain", DomainArgs.builder()
.compartmentId(compartmentId)
.description(domainDescription)
.displayName(domainDisplayName)
.homeRegion(domainHomeRegion)
.licenseType(domainLicenseType)
.adminEmail(domainAdminEmail)
.adminFirstName(domainAdminFirstName)
.adminLastName(domainAdminLastName)
.adminUserName(testUser.name())
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.isHiddenOnLogin(domainIsHiddenOnLogin)
.isNotificationBypassed(domainIsNotificationBypassed)
.isPrimaryEmailRequired(domainIsPrimaryEmailRequired)
.build());
}
}
resources:
testDomain:
type: oci:Identity:Domain
name: test_domain
properties:
compartmentId: ${compartmentId}
description: ${domainDescription}
displayName: ${domainDisplayName}
homeRegion: ${domainHomeRegion}
licenseType: ${domainLicenseType}
adminEmail: ${domainAdminEmail}
adminFirstName: ${domainAdminFirstName}
adminLastName: ${domainAdminLastName}
adminUserName: ${testUser.name}
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
isHiddenOnLogin: ${domainIsHiddenOnLogin}
isNotificationBypassed: ${domainIsNotificationBypassed}
isPrimaryEmailRequired: ${domainIsPrimaryEmailRequired}
Create Domain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
args: DomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
home_region: Optional[str] = None,
display_name: Optional[str] = None,
license_type: Optional[str] = None,
description: Optional[str] = None,
compartment_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
admin_first_name: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
admin_user_name: Optional[str] = None,
admin_email: Optional[str] = None,
is_hidden_on_login: Optional[bool] = None,
is_notification_bypassed: Optional[bool] = None,
is_primary_email_required: Optional[bool] = None,
admin_last_name: Optional[str] = None,
state: Optional[str] = None)
func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: oci:Identity:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var domainResource = new Oci.Identity.Domain("domainResource", new()
{
HomeRegion = "string",
DisplayName = "string",
LicenseType = "string",
Description = "string",
CompartmentId = "string",
FreeformTags =
{
{ "string", "string" },
},
AdminFirstName = "string",
DefinedTags =
{
{ "string", "string" },
},
AdminUserName = "string",
AdminEmail = "string",
IsHiddenOnLogin = false,
IsNotificationBypassed = false,
IsPrimaryEmailRequired = false,
AdminLastName = "string",
State = "string",
});
example, err := Identity.NewDomain(ctx, "domainResource", &Identity.DomainArgs{
HomeRegion: pulumi.String("string"),
DisplayName: pulumi.String("string"),
LicenseType: pulumi.String("string"),
Description: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
AdminFirstName: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
AdminUserName: pulumi.String("string"),
AdminEmail: pulumi.String("string"),
IsHiddenOnLogin: pulumi.Bool(false),
IsNotificationBypassed: pulumi.Bool(false),
IsPrimaryEmailRequired: pulumi.Bool(false),
AdminLastName: pulumi.String("string"),
State: pulumi.String("string"),
})
var domainResource = new Domain("domainResource", DomainArgs.builder()
.homeRegion("string")
.displayName("string")
.licenseType("string")
.description("string")
.compartmentId("string")
.freeformTags(Map.of("string", "string"))
.adminFirstName("string")
.definedTags(Map.of("string", "string"))
.adminUserName("string")
.adminEmail("string")
.isHiddenOnLogin(false)
.isNotificationBypassed(false)
.isPrimaryEmailRequired(false)
.adminLastName("string")
.state("string")
.build());
domain_resource = oci.identity.Domain("domainResource",
home_region="string",
display_name="string",
license_type="string",
description="string",
compartment_id="string",
freeform_tags={
"string": "string",
},
admin_first_name="string",
defined_tags={
"string": "string",
},
admin_user_name="string",
admin_email="string",
is_hidden_on_login=False,
is_notification_bypassed=False,
is_primary_email_required=False,
admin_last_name="string",
state="string")
const domainResource = new oci.identity.Domain("domainResource", {
homeRegion: "string",
displayName: "string",
licenseType: "string",
description: "string",
compartmentId: "string",
freeformTags: {
string: "string",
},
adminFirstName: "string",
definedTags: {
string: "string",
},
adminUserName: "string",
adminEmail: "string",
isHiddenOnLogin: false,
isNotificationBypassed: false,
isPrimaryEmailRequired: false,
adminLastName: "string",
state: "string",
});
type: oci:Identity:Domain
properties:
adminEmail: string
adminFirstName: string
adminLastName: string
adminUserName: string
compartmentId: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
homeRegion: string
isHiddenOnLogin: false
isNotificationBypassed: false
isPrimaryEmailRequired: false
licenseType: string
state: string
Domain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Domain resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- Description string
- (Updatable) Domain entity description
- Display
Name string - (Updatable) The mutable display name of the domain.
- Home
Region string - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- License
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Admin
Email string - The admin email address
- Admin
First stringName - The admin first name
- Admin
Last stringName - The admin last name
- Admin
User stringName - The admin user name
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Dictionary<string, string>
- (Updatable) 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"}
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- Is
Primary boolEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- State string
- The current state.
- Compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- Description string
- (Updatable) Domain entity description
- Display
Name string - (Updatable) The mutable display name of the domain.
- Home
Region string - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- License
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Admin
Email string - The admin email address
- Admin
First stringName - The admin first name
- Admin
Last stringName - The admin last name
- Admin
User stringName - The admin user name
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- map[string]string
- (Updatable) 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"}
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- Is
Primary boolEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- State string
- The current state.
- compartment
Id String - (Updatable) The OCID of the Compartment where domain is created
- description String
- (Updatable) Domain entity description
- display
Name String - (Updatable) The mutable display name of the domain.
- home
Region String - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- license
Type String The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- admin
Email String - The admin email address
- admin
First StringName - The admin first name
- admin
Last StringName - The admin last name
- admin
User StringName - The admin user name
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Map<String,String>
- (Updatable) 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"}
- Boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary BooleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- state String
- The current state.
- compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- description string
- (Updatable) Domain entity description
- display
Name string - (Updatable) The mutable display name of the domain.
- home
Region string - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- license
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- admin
Email string - The admin email address
- admin
First stringName - The admin first name
- admin
Last stringName - The admin last name
- admin
User stringName - The admin user name
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- {[key: string]: string}
- (Updatable) 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"}
- boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification booleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary booleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- state string
- The current state.
- compartment_
id str - (Updatable) The OCID of the Compartment where domain is created
- description str
- (Updatable) Domain entity description
- display_
name str - (Updatable) The mutable display name of the domain.
- home_
region str - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- license_
type str The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- admin_
email str - The admin email address
- admin_
first_ strname - The admin first name
- admin_
last_ strname - The admin last name
- admin_
user_ strname - The admin user name
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Mapping[str, str]
- (Updatable) 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"}
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is_
notification_ boolbypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is_
primary_ boolemail_ required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- state str
- The current state.
- compartment
Id String - (Updatable) The OCID of the Compartment where domain is created
- description String
- (Updatable) Domain entity description
- display
Name String - (Updatable) The mutable display name of the domain.
- home
Region String - The region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- license
Type String The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- admin
Email String - The admin email address
- admin
First StringName - The admin first name
- admin
Last StringName - The admin last name
- admin
User StringName - The admin user name
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Map<String>
- (Updatable) 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"}
- Boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary BooleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- state String
- The current state.
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Home
Region stringUrl - Region specific domain URL.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions List<DomainReplica Region> - The regions domain is replication to.
- 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 type of the domain.
- Url string
- Region agnostic domain URL.
- Home
Region stringUrl - Region specific domain URL.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions []DomainReplica Region - The regions domain is replication to.
- 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 type of the domain.
- Url string
- Region agnostic domain URL.
- home
Region StringUrl - Region specific domain URL.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<DomainReplica Region> - The regions domain is replication to.
- 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 type of the domain.
- url String
- Region agnostic domain URL.
- home
Region stringUrl - Region specific domain URL.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - Any additional details about the current state of the Domain.
- replica
Regions DomainReplica Region[] - The regions domain is replication to.
- 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 type of the domain.
- url string
- Region agnostic domain URL.
- home_
region_ strurl - Region specific domain URL.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - Any additional details about the current state of the Domain.
- replica_
regions Sequence[identity.Domain Replica Region] - The regions domain is replication to.
- 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 type of the domain.
- url str
- Region agnostic domain URL.
- home
Region StringUrl - Region specific domain URL.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<Property Map> - The regions domain is replication to.
- 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 type of the domain.
- url String
- Region agnostic domain URL.
Look up Existing Domain Resource
Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_email: Optional[str] = None,
admin_first_name: Optional[str] = None,
admin_last_name: Optional[str] = None,
admin_user_name: Optional[str] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
home_region: Optional[str] = None,
home_region_url: Optional[str] = None,
is_hidden_on_login: Optional[bool] = None,
is_notification_bypassed: Optional[bool] = None,
is_primary_email_required: Optional[bool] = None,
license_type: Optional[str] = None,
lifecycle_details: Optional[str] = None,
replica_regions: Optional[Sequence[_identity.DomainReplicaRegionArgs]] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
type: Optional[str] = None,
url: Optional[str] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Admin
Email string - The admin email address
- Admin
First stringName - The admin first name
- Admin
Last stringName - The admin last name
- Admin
User stringName - The admin user name
- Compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) Domain entity description
- Display
Name string - (Updatable) The mutable display name of the domain.
- Dictionary<string, string>
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- Home
Region stringUrl - Region specific domain URL.
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- Is
Primary boolEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- License
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions List<DomainReplica Region> - The regions domain is replication to.
- State string
- The current state.
- 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 type of the domain.
- Url string
- Region agnostic domain URL.
- Admin
Email string - The admin email address
- Admin
First stringName - The admin first name
- Admin
Last stringName - The admin last name
- Admin
User stringName - The admin user name
- Compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- map[string]string
- (Updatable) 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
- (Updatable) Domain entity description
- Display
Name string - (Updatable) The mutable display name of the domain.
- map[string]string
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- Home
Region stringUrl - Region specific domain URL.
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- Is
Notification boolBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- Is
Primary boolEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- License
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Lifecycle
Details string - Any additional details about the current state of the Domain.
- Replica
Regions []DomainReplica Region Args - The regions domain is replication to.
- State string
- The current state.
- 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 type of the domain.
- Url string
- Region agnostic domain URL.
- admin
Email String - The admin email address
- admin
First StringName - The admin first name
- admin
Last StringName - The admin last name
- admin
User StringName - The admin user name
- compartment
Id String - (Updatable) The OCID of the Compartment where domain is created
- Map<String,String>
- (Updatable) 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
- (Updatable) Domain entity description
- display
Name String - (Updatable) The mutable display name of the domain.
- Map<String,String>
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- home
Region StringUrl - Region specific domain URL.
- Boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary BooleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- license
Type String The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle
Details String - Any additional details about the current state of the Domain.
- replica
Regions List<DomainReplica Region> - The regions domain is replication to.
- state String
- The current state.
- 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 type of the domain.
- url String
- Region agnostic domain URL.
- admin
Email string - The admin email address
- admin
First stringName - The admin first name
- admin
Last stringName - The admin last name
- admin
User stringName - The admin user name
- compartment
Id string - (Updatable) The OCID of the Compartment where domain is created
- {[key: string]: string}
- (Updatable) 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
- (Updatable) Domain entity description
- display
Name string - (Updatable) The mutable display name of the domain.
- {[key: string]: string}
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- home
Region stringUrl - Region specific domain URL.
- boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification booleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary booleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- license
Type string The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle
Details string - Any additional details about the current state of the Domain.
- replica
Regions DomainReplica Region[] - The regions domain is replication to.
- state string
- The current state.
- 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 type of the domain.
- url string
- Region agnostic domain URL.
- admin_
email str - The admin email address
- admin_
first_ strname - The admin first name
- admin_
last_ strname - The admin last name
- admin_
user_ strname - The admin user name
- compartment_
id str - (Updatable) The OCID of the Compartment where domain is created
- Mapping[str, str]
- (Updatable) 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
- (Updatable) Domain entity description
- display_
name str - (Updatable) The mutable display name of the domain.
- Mapping[str, str]
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- home_
region_ strurl - Region specific domain URL.
- bool
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is_
notification_ boolbypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is_
primary_ boolemail_ required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- license_
type str The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle_
details str - Any additional details about the current state of the Domain.
- replica_
regions Sequence[identity.Domain Replica Region Args] - The regions domain is replication to.
- state str
- The current state.
- 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 type of the domain.
- url str
- Region agnostic domain URL.
- admin
Email String - The admin email address
- admin
First StringName - The admin first name
- admin
Last StringName - The admin last name
- admin
User StringName - The admin user name
- compartment
Id String - (Updatable) The OCID of the Compartment where domain is created
- Map<String>
- (Updatable) 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
- (Updatable) Domain entity description
- display
Name String - (Updatable) The mutable display name of the domain.
- Map<String>
- (Updatable) 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 region's name. See Regions and Availability Domains for the full list of supported region names. Example:
us-phoenix-1
- home
Region StringUrl - Region specific domain URL.
- Boolean
- (Updatable) Indicates whether domain is hidden on login screen or not.
- is
Notification BooleanBypassed - Indicates if admin user created in IDCS stripe would like to receive notification like welcome email or not. Required field only if admin information is provided, otherwise optional.
- is
Primary BooleanEmail Required - Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true
- license
Type String The License type of Domain
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- 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
- The current state.
- 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 type of the domain.
- url String
- Region agnostic domain URL.
Supporting Types
DomainReplicaRegion, DomainReplicaRegionArgs
- 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
- The current state.
- Url string
- 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
- The current state.
- Url string
- 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
- The current state.
- url String
- 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
- The current state.
- url string
- 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
- The current state.
- url str
- 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
- The current state.
- url String
- Region agnostic domain URL.
Import
Domains can be imported using the id
, e.g.
$ pulumi import oci:Identity/domain:Domain test_domain "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.