Class ListDomainsRequest

Inheritance

object

ListDomainsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentityService.Requests

Assembly: OCI.DotNetSDK.Identity.dll

Syntax

public class ListDomainsRequest : IOciRequest

Examples

Click here to see an example of how to use ListDomains request.

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment (remember that the tenancy is simply the root compartment).

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The mutable display name of the identity domain.

HomeRegionUrl

Declaration

[HttpConverter(TargetEnum.Query, "homeRegionUrl")]
public string HomeRegionUrl { get; set; }

Property Value

Type	Description
string	The region-specific identity domain URL.

IsHiddenOnLogin

Declaration

[HttpConverter(TargetEnum.Query, "isHiddenOnLogin")]
public bool? IsHiddenOnLogin { get; set; }

Property Value

Type	Description
bool?	Indicates whether or not the identity domain is visible at the sign-in screen.

LicenseType

Declaration

[HttpConverter(TargetEnum.Query, "licenseType")]
public string LicenseType { get; set; }

Property Value

Type	Description
string	The license type of the identity domain.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Domain.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Domain.LifecycleStateEnum?	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return in a paginated "List" call.

Name

Declaration

[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }

Property Value

Type	Description
string	A filter to only return resources that match the given name exactly.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The value of the opc-next-page response header from the previous "List" call.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDomainsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type

Description

ListDomainsRequest.SortByEnum?

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDomainsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListDomainsRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

Type

Declaration

[HttpConverter(TargetEnum.Query, "type")]
public string Type { get; set; }

Property Value

Type	Description
string	The identity domain type.

Url

Declaration

[HttpConverter(TargetEnum.Query, "url")]
public string Url { get; set; }

Property Value

Type	Description
string	The region-agnostic identity domain URL.

Implements

IOciRequest