Show / Hide Table of Contents

Class CreateDomainDetails

(For tenancies that support identity domains) Details for creating an identity domain.

Inheritance
object
CreateDomainDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class CreateDomainDetails

Properties

AdminEmail

Declaration
[JsonProperty(PropertyName = "adminEmail")]
public string AdminEmail { get; set; }
Property Value
Type Description
string

The administrator's email address.

AdminFirstName

Declaration
[JsonProperty(PropertyName = "adminFirstName")]
public string AdminFirstName { get; set; }
Property Value
Type Description
string

The administrator's first name.

AdminLastName

Declaration
[JsonProperty(PropertyName = "adminLastName")]
public string AdminLastName { get; set; }
Property Value
Type Description
string

The administrator's last name.

AdminUserName

Declaration
[JsonProperty(PropertyName = "adminUserName")]
public string AdminUserName { get; set; }
Property Value
Type Description
string

The administrator's user name.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment where the identity domain is created.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Declaration
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

The identity domain description. You can have an empty description.

Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The mutable display name of the identity domain.

Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
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"}

HomeRegion

Declaration
[Required(ErrorMessage = "HomeRegion is required.")]
[JsonProperty(PropertyName = "homeRegion")]
public string HomeRegion { get; set; }
Property Value
Type Description
string

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

Remarks

Required

IsHiddenOnLogin

Declaration
[JsonProperty(PropertyName = "isHiddenOnLogin")]
public bool? IsHiddenOnLogin { get; set; }
Property Value
Type Description
bool?

Indicates whether the identity domain is hidden on the sign-in screen or not.

IsNotificationBypassed

Declaration
[JsonProperty(PropertyName = "isNotificationBypassed")]
public bool? IsNotificationBypassed { get; set; }
Property Value
Type Description
bool?

Indicates whether or not the administrator user created in the IDCS stripe would like to receive notifications like a welcome email. This field is required only if admin information is provided. This field is otherwise optional.

IsPrimaryEmailRequired

Declaration
[JsonProperty(PropertyName = "isPrimaryEmailRequired")]
public bool? IsPrimaryEmailRequired { get; set; }
Property Value
Type Description
bool?

Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true.

LicenseType

Declaration
[Required(ErrorMessage = "LicenseType is required.")]
[JsonProperty(PropertyName = "licenseType")]
public string LicenseType { get; set; }
Property Value
Type Description
string

The license type of the identity domain.

Remarks

Required

In this article
Back to top