Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

Domain

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

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDomain = new Oci.Identity.Domain("testDomain", new Oci.Identity.DomainArgs
        {
            CompartmentId = @var.Compartment_id,
            Description = @var.Domain_description,
            DisplayName = @var.Domain_display_name,
            HomeRegion = @var.Domain_home_region,
            LicenseType = @var.Domain_license_type,
            AdminEmail = @var.Domain_admin_email,
            AdminFirstName = @var.Domain_admin_first_name,
            AdminLastName = @var.Domain_admin_last_name,
            AdminUserName = oci_identity_user.Test_user.Name,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            IsHiddenOnLogin = @var.Domain_is_hidden_on_login,
            IsNotificationBypassed = @var.Domain_is_notification_bypassed,
            IsPrimaryEmailRequired = @var.Domain_is_primary_email_required,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Identity.NewDomain(ctx, "testDomain", &Identity.DomainArgs{
			CompartmentId:  pulumi.Any(_var.Compartment_id),
			Description:    pulumi.Any(_var.Domain_description),
			DisplayName:    pulumi.Any(_var.Domain_display_name),
			HomeRegion:     pulumi.Any(_var.Domain_home_region),
			LicenseType:    pulumi.Any(_var.Domain_license_type),
			AdminEmail:     pulumi.Any(_var.Domain_admin_email),
			AdminFirstName: pulumi.Any(_var.Domain_admin_first_name),
			AdminLastName:  pulumi.Any(_var.Domain_admin_last_name),
			AdminUserName:  pulumi.Any(oci_identity_user.Test_user.Name),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IsHiddenOnLogin:        pulumi.Any(_var.Domain_is_hidden_on_login),
			IsNotificationBypassed: pulumi.Any(_var.Domain_is_notification_bypassed),
			IsPrimaryEmailRequired: pulumi.Any(_var.Domain_is_primary_email_required),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_domain = oci.identity.Domain("testDomain",
    compartment_id=var["compartment_id"],
    description=var["domain_description"],
    display_name=var["domain_display_name"],
    home_region=var["domain_home_region"],
    license_type=var["domain_license_type"],
    admin_email=var["domain_admin_email"],
    admin_first_name=var["domain_admin_first_name"],
    admin_last_name=var["domain_admin_last_name"],
    admin_user_name=oci_identity_user["test_user"]["name"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    freeform_tags={
        "Department": "Finance",
    },
    is_hidden_on_login=var["domain_is_hidden_on_login"],
    is_notification_bypassed=var["domain_is_notification_bypassed"],
    is_primary_email_required=var["domain_is_primary_email_required"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDomain = new oci.identity.Domain("testDomain", {
    compartmentId: _var.compartment_id,
    description: _var.domain_description,
    displayName: _var.domain_display_name,
    homeRegion: _var.domain_home_region,
    licenseType: _var.domain_license_type,
    adminEmail: _var.domain_admin_email,
    adminFirstName: _var.domain_admin_first_name,
    adminLastName: _var.domain_admin_last_name,
    adminUserName: oci_identity_user.test_user.name,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    freeformTags: {
        Department: "Finance",
    },
    isHiddenOnLogin: _var.domain_is_hidden_on_login,
    isNotificationBypassed: _var.domain_is_notification_bypassed,
    isPrimaryEmailRequired: _var.domain_is_primary_email_required,
});

Coming soon!

Create a Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: 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, Any]] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           freeform_tags: Optional[Mapping[str, Any]] = None,
           home_region: 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,
           state: Optional[str] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = 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.

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.

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:

CompartmentId string

(Updatable) The OCID of the Compartment where domain is created

Description string

(Updatable) Domain entity description

DisplayName string

(Updatable) The mutable display name of the domain.

HomeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

LicenseType string

The License type of Domain

AdminEmail string

The admin email address

AdminFirstName string

The admin first name

AdminLastName string

The admin last name

AdminUserName string

The admin user name

DefinedTags Dictionary<string, object>

(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"}

FreeformTags Dictionary<string, object>

(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"}

IsHiddenOnLogin bool

(Updatable) Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool

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.

IsPrimaryEmailRequired bool

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.

CompartmentId string

(Updatable) The OCID of the Compartment where domain is created

Description string

(Updatable) Domain entity description

DisplayName string

(Updatable) The mutable display name of the domain.

HomeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

LicenseType string

The License type of Domain

AdminEmail string

The admin email address

AdminFirstName string

The admin first name

AdminLastName string

The admin last name

AdminUserName string

The admin user name

DefinedTags map[string]interface{}

(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"}

FreeformTags map[string]interface{}

(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"}

IsHiddenOnLogin bool

(Updatable) Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool

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.

IsPrimaryEmailRequired bool

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.

compartmentId String

(Updatable) The OCID of the Compartment where domain is created

description String

(Updatable) Domain entity description

displayName String

(Updatable) The mutable display name of the domain.

homeRegion String

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

licenseType String

The License type of Domain

adminEmail String

The admin email address

adminFirstName String

The admin first name

adminLastName String

The admin last name

adminUserName String

The admin user name

definedTags Map<String,Object>

(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"}

freeformTags Map<String,Object>

(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"}

isHiddenOnLogin Boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean

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.

isPrimaryEmailRequired Boolean

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.

compartmentId string

(Updatable) The OCID of the Compartment where domain is created

description string

(Updatable) Domain entity description

displayName string

(Updatable) The mutable display name of the domain.

homeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

licenseType string

The License type of Domain

adminEmail string

The admin email address

adminFirstName string

The admin first name

adminLastName string

The admin last name

adminUserName string

The admin user name

definedTags {[key: string]: any}

(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"}

freeformTags {[key: string]: any}

(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"}

isHiddenOnLogin boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed boolean

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.

isPrimaryEmailRequired boolean

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

admin_email str

The admin email address

admin_first_name str

The admin first name

admin_last_name str

The admin last name

admin_user_name str

The admin user name

defined_tags Mapping[str, Any]

(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"}

freeform_tags Mapping[str, Any]

(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"}

is_hidden_on_login bool

(Updatable) Indicates whether domain is hidden on login screen or not.

is_notification_bypassed bool

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_email_required bool

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.

compartmentId String

(Updatable) The OCID of the Compartment where domain is created

description String

(Updatable) Domain entity description

displayName String

(Updatable) The mutable display name of the domain.

homeRegion String

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

licenseType String

The License type of Domain

adminEmail String

The admin email address

adminFirstName String

The admin first name

adminLastName String

The admin last name

adminUserName String

The admin user name

definedTags Map<Any>

(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"}

freeformTags Map<Any>

(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"}

isHiddenOnLogin Boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean

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.

isPrimaryEmailRequired Boolean

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:

HomeRegionUrl string

Region specific domain URL.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions List<DomainReplicaRegion>

The regions domain is replication to.

TimeCreated 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.

HomeRegionUrl string

Region specific domain URL.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions []DomainReplicaRegion

The regions domain is replication to.

TimeCreated 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.

homeRegionUrl String

Region specific domain URL.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<DomainReplicaRegion>

The regions domain is replication to.

timeCreated 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.

homeRegionUrl string

Region specific domain URL.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

Any additional details about the current state of the Domain.

replicaRegions DomainReplicaRegion[]

The regions domain is replication to.

timeCreated 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_url str

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 DomainReplicaRegion]

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.

homeRegionUrl String

Region specific domain URL.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<Property Map>

The regions domain is replication to.

timeCreated 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 an 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, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = 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.
The following state arguments are supported:
AdminEmail string

The admin email address

AdminFirstName string

The admin first name

AdminLastName string

The admin last name

AdminUserName string

The admin user name

CompartmentId string

(Updatable) The OCID of the Compartment where domain is created

DefinedTags Dictionary<string, object>

(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

DisplayName string

(Updatable) The mutable display name of the domain.

FreeformTags Dictionary<string, object>

(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"}

HomeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

HomeRegionUrl string

Region specific domain URL.

IsHiddenOnLogin bool

(Updatable) Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool

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.

IsPrimaryEmailRequired bool

Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true

LicenseType string

The License type of Domain

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions List<DomainReplicaRegionArgs>

The regions domain is replication to.

State string

The current state.

TimeCreated 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.

AdminEmail string

The admin email address

AdminFirstName string

The admin first name

AdminLastName string

The admin last name

AdminUserName string

The admin user name

CompartmentId string

(Updatable) The OCID of the Compartment where domain is created

DefinedTags map[string]interface{}

(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

DisplayName string

(Updatable) The mutable display name of the domain.

FreeformTags map[string]interface{}

(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"}

HomeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

HomeRegionUrl string

Region specific domain URL.

IsHiddenOnLogin bool

(Updatable) Indicates whether domain is hidden on login screen or not.

IsNotificationBypassed bool

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.

IsPrimaryEmailRequired bool

Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true

LicenseType string

The License type of Domain

LifecycleDetails string

Any additional details about the current state of the Domain.

ReplicaRegions []DomainReplicaRegionArgs

The regions domain is replication to.

State string

The current state.

TimeCreated 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.

adminEmail String

The admin email address

adminFirstName String

The admin first name

adminLastName String

The admin last name

adminUserName String

The admin user name

compartmentId String

(Updatable) The OCID of the Compartment where domain is created

definedTags Map<String,Object>

(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

displayName String

(Updatable) The mutable display name of the domain.

freeformTags Map<String,Object>

(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"}

homeRegion String

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl String

Region specific domain URL.

isHiddenOnLogin Boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean

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.

isPrimaryEmailRequired Boolean

Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true

licenseType String

The License type of Domain

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<DomainReplicaRegionArgs>

The regions domain is replication to.

state String

The current state.

timeCreated 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.

adminEmail string

The admin email address

adminFirstName string

The admin first name

adminLastName string

The admin last name

adminUserName string

The admin user name

compartmentId string

(Updatable) The OCID of the Compartment where domain is created

definedTags {[key: string]: any}

(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

displayName string

(Updatable) The mutable display name of the domain.

freeformTags {[key: string]: any}

(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"}

homeRegion string

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl string

Region specific domain URL.

isHiddenOnLogin boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed boolean

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.

isPrimaryEmailRequired boolean

Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true

licenseType string

The License type of Domain

lifecycleDetails string

Any additional details about the current state of the Domain.

replicaRegions DomainReplicaRegionArgs[]

The regions domain is replication to.

state string

The current state.

timeCreated 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_name str

The admin first name

admin_last_name str

The admin last name

admin_user_name str

The admin user name

compartment_id str

(Updatable) The OCID of the Compartment where domain is created

defined_tags Mapping[str, Any]

(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.

freeform_tags Mapping[str, Any]

(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_url str

Region specific domain URL.

is_hidden_on_login bool

(Updatable) Indicates whether domain is hidden on login screen or not.

is_notification_bypassed bool

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_email_required bool

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

lifecycle_details str

Any additional details about the current state of the Domain.

replica_regions DomainReplicaRegionArgs]

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.

adminEmail String

The admin email address

adminFirstName String

The admin first name

adminLastName String

The admin last name

adminUserName String

The admin user name

compartmentId String

(Updatable) The OCID of the Compartment where domain is created

definedTags Map<Any>

(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

displayName String

(Updatable) The mutable display name of the domain.

freeformTags Map<Any>

(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"}

homeRegion String

The region's name. See Regions and Availability Domains for the full list of supported region names. Example: us-phoenix-1

homeRegionUrl String

Region specific domain URL.

isHiddenOnLogin Boolean

(Updatable) Indicates whether domain is hidden on login screen or not.

isNotificationBypassed Boolean

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.

isPrimaryEmailRequired Boolean

Optional field to indicate whether users in the domain are required to have a primary email address or not Defaults to true

licenseType String

The License type of Domain

lifecycleDetails String

Any additional details about the current state of the Domain.

replicaRegions List<Property Map>

The regions domain is replication to.

state String

The current state.

timeCreated 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

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"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.