Show / Hide Table of Contents

Class ListDomainsRequest

Inheritance
System.Object
ListDomainsRequest
Implements
IOciRequest
Namespace: Oci.IdentityService.Requests
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class ListDomainsRequest : object, IOciRequest
Examples

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

Properties

CompartmentId

Declaration
public string CompartmentId { get; set; }
Property Value
Type Description
System.String

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

Remarks

Required

DisplayName

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

The mutable display name of the identity domain.

HomeRegionUrl

Declaration
public string HomeRegionUrl { get; set; }
Property Value
Type Description
System.String

The region-specific identity domain URL.

IsHiddenOnLogin

Declaration
public System.Nullable<bool> IsHiddenOnLogin { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Indicates whether or not the identity domain is visible at the sign-in screen.

LicenseType

Declaration
public string LicenseType { get; set; }
Property Value
Type Description
System.String

The license type of the identity domain.

LifecycleState

Declaration
public System.Nullable<Domain.LifecycleStateEnum> LifecycleState { get; set; }
Property Value
Type Description
System.Nullable<Domain.LifecycleStateEnum>

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration
public System.Nullable<int> Limit { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

The maximum number of items to return in a paginated &quot;List&quot; call.

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

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

OpcRequestId

Declaration
public string OpcRequestId { get; set; }
Property Value
Type Description
System.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
public string Page { get; set; }
Property Value
Type Description
System.String

The value of the opc-next-page response header from the previous &quot;List&quot; call.

SortBy

Declaration
public System.Nullable<ListDomainsRequest.SortByEnum> SortBy { get; set; }
Property Value
Type Description
System.Nullable<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 &quot;List&quot; 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 &quot;List&quot; operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

SortOrder

Declaration
public System.Nullable<ListDomainsRequest.SortOrderEnum> SortOrder { get; set; }
Property Value
Type Description
System.Nullable<ListDomainsRequest.SortOrderEnum>

The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

Type

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String

The identity domain type.

Url

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

The region-agnostic identity domain URL.

Implements

IOciRequest
In This Article
Back to top