AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListUsers operation. Lists the users in the Amazon Cognito user pool.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.ListUsersRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class ListUsersRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The ListUsersRequest type exposes the following members

Constructors

NameDescription
Public Method ListUsersRequest()

Properties

NameTypeDescription
Public Property AttributesToGet System.Collections.Generic.List<System.String>

Gets and sets the property AttributesToGet.

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned.

Public Property Filter System.String

Gets and sets the property Filter.

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 Enabled in the Console) (case-sensitive)

  • status (case-insensitive)

Custom attributes are not searchable.

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

Public Property Limit System.Int32

Gets and sets the property Limit.

Maximum number of users to be returned.

Public Property PaginationToken System.String

Gets and sets the property PaginationToken.

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms