Package com.ibm.cloud.platform_services.user_management.v1.model

Class ListUsersOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class ListUsersOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The listUsers options.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String accountId()
      Gets the accountId.
      java.lang.Boolean includeSettings()
      Gets the includeSettings.
      java.lang.Long limit()
      Gets the limit.
      ListUsersOptions.Builder newBuilder()
      New builder.
      java.lang.String search()
      Gets the search.
      java.lang.String start()
      Gets the start.
      java.lang.String userId()
      Gets the userId.

      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • accountId

        public java.lang.String accountId()
        Gets the accountId. The account ID of the specified user.
        Returns:
        the accountId

      • limit

        public java.lang.Long limit()
        Gets the limit. The number of results to be returned.
        Returns:
        the limit

      • includeSettings

        public java.lang.Boolean includeSettings()
        Gets the includeSettings. The user settings to be returned. Set to true to view language, allowed IP address, and authentication settings.
        Returns:
        the includeSettings

      • search

        public java.lang.String search()
        Gets the search. The desired search results to be returned. To view the list of users with the additional search filter, use the following query options: `firstname`, `lastname`, `email`, `state`, `substate`, `iam_id`, `realm`, and `userId`. HTML URL encoding for the search query and `:` must be used. For example, search=state%3AINVALID returns a list of invalid users. Multiple search queries can be combined to obtain `OR` results using `,` operator (not URL encoded). For example, search=state%3AINVALID,email%3Amail.test.ibm.com.
        Returns:
        the search

      • start

        public java.lang.String start()
        Gets the start. An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of results is returned. This value is obtained from the 'next_url' field of the operation response.
        Returns:
        the start

      • userId

        public java.lang.String userId()
        Gets the userId. Filter users based on their user ID.
        Returns:
        the userId