Class Domain
(For tenancies that support identity domains) Properties for an identity domain. An identity domain is used to manage users and groups, integration standards, external identities, and secure application integration through Oracle Single Sign-on (SSO) configuration.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class Domain
Properties
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 containing the identity domain. |
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 home region for the identity domain.
See Regions and Availability Domains
for the full list of supported region names.
|
Remarks
Required
HomeRegionUrl
Declaration
[Required(ErrorMessage = "HomeRegionUrl is required.")]
[JsonProperty(PropertyName = "homeRegionUrl")]
public string HomeRegionUrl { get; set; }
Property Value
Type | Description |
---|---|
string | Region-specific identity domain URL. |
Remarks
Required
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the identity domain. |
Remarks
Required
IsHiddenOnLogin
Declaration
[Required(ErrorMessage = "IsHiddenOnLogin is required.")]
[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. |
Remarks
Required
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
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Domain.LifecycleDetailsEnum? LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
Domain.LifecycleDetailsEnum? | Any additional details about the current state of the identity domain. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Domain.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Domain.LifecycleStateEnum? | The current state. |
Remarks
Required
ReplicaRegions
Declaration
[Required(ErrorMessage = "ReplicaRegions is required.")]
[JsonProperty(PropertyName = "replicaRegions")]
public List<ReplicatedRegionDetails> ReplicaRegions { get; set; }
Property Value
Type | Description |
---|---|
List<ReplicatedRegionDetails> | The regions where replicas of the identity domain exist. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time the identity domain was created, in the format defined by RFC3339.
|
Remarks
Required
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Domain.TypeEnum? Type { get; set; }
Property Value
Type | Description |
---|---|
Domain.TypeEnum? | The type of the domain. |
Remarks
Required
Url
Declaration
[Required(ErrorMessage = "Url is required.")]
[JsonProperty(PropertyName = "url")]
public string Url { get; set; }
Property Value
Type | Description |
---|---|
string | Region-agnostic identity domain URL. |
Remarks
Required