Class ListUsersRequest


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

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/datasafe/ListUsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUsersRequest.

    • Constructor Detail

      • ListUsersRequest

        public ListUsersRequest()
    • Method Detail

      • getUserAssessmentId

        public String getUserAssessmentId()
        The OCID of the user assessment.
      • getLimit

        public Integer getLimit()
        For list pagination.

        The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        Default is false.

        When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

      • getAccessLevel

        public ListUsersRequest.AccessLevel getAccessLevel()
        Valid values are RESTRICTED and ACCESSIBLE.

        Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

      • getUserCategory

        public String getUserCategory()
        A filter to return only items that match the specified user category.
      • getUserRole

        public String getUserRole()
        A filter to return only items that match the specified user role.
      • getUserProfile

        public String getUserProfile()
        A filter to return only items that match the specified user profile.
      • getUserType

        public String getUserType()
        A filter to return only items that match the specified user type.

        The possible values can be

        • ADMIN_PRIVILEGED - APPLICATION - PRIVILEGED - SCHEMA - NON_PRIVILEGED as specified by ‘#/definitions/userTypes’.
      • getUserKey

        public String getUserKey()
        A filter to return only items that match the specified user key.
      • getAccountStatus

        public String getAccountStatus()
        A filter to return only items that match the specified account status.
      • getAuthenticationType

        public String getAuthenticationType()
        A filter to return only items that match the specified authentication type.
      • getUserName

        public String getUserName()
        A filter to return only items that match the specified user name.
      • getTargetId

        public String getTargetId()
        A filter to return only items related to a specific target OCID.
      • getTimeLastLoginGreaterThanOrEqualTo

        public Date getTimeLastLoginGreaterThanOrEqualTo()
        A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

        *Example:** 2016-12-19T16:39:57.600Z

      • getTimeLastLoginLessThan

        public Date getTimeLastLoginLessThan()
        A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339.

        Example: 2016-12-19T16:39:57.600Z

      • getTimeUserCreatedGreaterThanOrEqualTo

        public Date getTimeUserCreatedGreaterThanOrEqualTo()
        A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

        Example: 2016-12-19T16:39:57.600Z

      • getTimeUserCreatedLessThan

        public Date getTimeUserCreatedLessThan()
        A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339.

        Example: 2016-12-19T16:39:57.600Z

      • getTimePasswordLastChangedGreaterThanOrEqualTo

        public Date getTimePasswordLastChangedGreaterThanOrEqualTo()
        A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

        *Example:** 2016-12-19T16:39:57.600Z

      • getTimePasswordLastChangedLessThan

        public Date getTimePasswordLastChangedLessThan()
        A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.

        *Example:** 2016-12-19T16:39:57.600Z

      • getTimePasswordExpiryGreaterThanOrEqualTo

        public Date getTimePasswordExpiryGreaterThanOrEqualTo()
        A filter to return users whose password expiry date in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.

        Example: 2016-12-19T16:39:57.600Z

      • getTimePasswordExpiryLessThan

        public Date getTimePasswordExpiryLessThan()
        A filter to return users whose password expiry date in the database is less than the date and time specified, in the format defined by RFC3339.

        Example: 2016-12-19T16:39:57.600Z

      • getPage

        public String getPage()
        For list pagination.

        The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

      • getSortOrder

        public ListUsersRequest.SortOrder getSortOrder()
        The sort order to use, either ascending (ASC) or descending (DESC).
      • getSortBy

        public ListUsersRequest.SortBy getSortBy()
        The field to sort by.

        You can specify only one sort order (sortOrder). The default order for userName is ascending.

      • getOpcRequestId

        public String getOpcRequestId()
        Unique identifier for the request.
      • getSchemaList

        public List<String> getSchemaList()
        A filter to return items that contain the specified schema list.
      • getAreAllSchemasAccessible

        public Boolean getAreAllSchemasAccessible()
        A filter to return only items that match the criteria that all schemas can be accessed by a user.
      • builder

        public static ListUsersRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object
      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>
      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>