Class: Aws::CognitoIdentityProvider::Types::ListUsersRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to list users.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes_to_get ⇒ Array<String>

A JSON array of user attribute names, for example ‘given_name`, that you want Amazon Cognito to include in the response for each user. When you don’t provide an ‘AttributesToGet` parameter, Amazon Cognito returns all attributes for each user.

Use ‘AttributesToGet` with required attributes in your user pool, or in conjunction with `Filter`. Amazon Cognito returns an error if not all users in the results have set a value for the attribute you request. Attributes that you can’t filter on, including custom attributes, must have a value set in every user profile before an ‘AttributesToGet` parameter returns results.

Returns:

  • (Array<String>) 


6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6437

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ String

A filter string of the form “AttributeName Filter-Type ”AttributeValue“”. Quotation marks within the filter string must be escaped using the backslash (“) character. For example, ‘“family_name = ”Reddy“”`.

  • AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

  • Filter-Type: For an exact match, use ‘=`, for example, “`given_name = ”Jon“`”. For a prefix (“starts with”) match, use `^=`, for example, “`given_name ^= ”Jon“`”.

  • AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ‘ListUsers` returns all users in the user pool.

You can only search for the following standard attributes:

  • ‘username` (case-sensitive)

  • ‘email`

  • ‘phone_number`

  • ‘name`

  • ‘given_name`

  • ‘family_name`

  • ‘preferred_username`

  • ‘cognito:user_status` (called Status in the Console) (case-insensitive)

  • ‘status (called Enabled in the Console) (case-sensitive)`

  • ‘sub`

Custom attributes aren’t searchable.

<note markdown=“1”> You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the ‘–query` parameter of the `list-users` action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.

For more information about server-side and client-side filtering,

see [FilteringCLI output] in the [Command Line Interface User Guide].

</note>

For more information, see [Searching for Users Using the ListUsers API] and [Examples of Using the ListUsers API] in the *Amazon Cognito Developer Guide*.

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api [3]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples

Returns:

  • (String) 


6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6437

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

Maximum number of users to be returned.

Returns:

  • (Integer) 


6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6437

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#pagination_token ⇒ String

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

  • (String) 


6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6437

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID for the user pool on which the search should be performed.

Returns:

  • (String) 


6437
6438
6439
6440
6441
6442
6443
6444
6445
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6437

class ListUsersRequest < Struct.new(
  :user_pool_id,
  :attributes_to_get,
  :limit,
  :pagination_token,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end