com.oracle.bmc.identity.requests

Class ListUsersRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.identity.requests.ListUsersRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListUsersRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListUsersRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListUsersRequest.Builder
static class	ListUsersRequest.SortBy The field to sort by.
static class	ListUsersRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListUsersRequest.Builder	builder()
String	getCompartmentId() The OCID of the compartment (remember that the tenancy is simply the root compartment).
String	getExternalIdentifier() The id of a user in the identity provider.
String	getIdentityProviderId() The id of the identity provider.
User.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() The maximum number of items to return in a paginated "List" call.
String	getName() A filter to only return resources that match the given name exactly.
String	getPage() The value of the opc-next-page response header from the previous "List" call.
ListUsersRequest.SortBy	getSortBy() The field to sort by.
ListUsersRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListUsersRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

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

getPage

public String getPage()

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

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated "List" call.

getIdentityProviderId

public String getIdentityProviderId()

The id of the identity provider.

getExternalIdentifier

public String getExternalIdentifier()

The id of a user in the identity provider.

getName

public String getName()

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

getSortBy

public ListUsersRequest.SortBy getSortBy()

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.

getSortOrder

public ListUsersRequest.SortOrder getSortOrder()

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

getLifecycleState

public User.LifecycleState getLifecycleState()

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